How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nhost files API

File management operations

Nhost files API is one of 14 APIs that Nhost publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include File. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{subdomain}.storage.{region}.nhost.run/v1.

5 operations 2 paths 7 schemas 1 DELETE1 GET1 HEAD1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{subdomain}.nhost.run/v1/graphql
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Nhost files API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Authorization). An API key is passed in the header as X-Hasura-Admin-Secret (X-Hasura-Admin-Secret).

  • Authorization — API key to authorize requests.
  • X-Hasura-Admin-Secret — Hasura admin secret key for backend/administrative operations.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 1 HEAD, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

files 5

File management operations

POST
/files
Upload files
uploadFiles body → 201default
DELETE
/files/{id}
Delete file
deleteFile 1 param → 204default
GET
/files/{id}
Download file
getFile 11 params → 200206304412default
HEAD
/files/{id}
Check file information
getFileMetadataHeaders 10 params → 200304412default
PUT
/files/{id}
Replace file
replaceFile 1 param body → 200default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are FileMetadata (11 properties), UploadFileMetadata (3 properties), UpdateFileMetadata (2 properties), ErrorResponseWithProcessedFiles (2 properties). Each schema is shown below with its type and property counts.

ErrorResponseWithProcessedFiles
object
Error information returned by the API.
2 properties
OutputImageFormat
string
Output format for image files. Use 'auto' for content negotiation based on Accept header
ErrorResponse
object
Error information returned by the API.
1 property
UploadFileMetadata
object
Metadata provided when uploading a new file.
3 properties
UpdateFileMetadata
object
Metadata that can be updated for an existing file.
2 properties
FileMetadata
object
Comprehensive metadata information about a file in storage.
11 properties 9 required
RFC2822Date
string
Date in RFC 2822 format

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhost-files-api-openapi.yml Raw ↑

Other APIs Nhost publishes across the network.

Nhost GraphQL API
Nhost Serverless Functions API
Nhost AI API
Nhost authentication API
Nhost documentation API
Nhost excludeme API
Nhost operations API
Nhost security API
Nhost session API
Nhost storage API
Nhost system API
Nhost user API
Where this information came from

This is an independent, third-party profile of Nhost files API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.