Haystack / deepset Files API
Upload, list, delete, and annotate files; manage upload sessions.
Haystack / deepset Files API is one of 6 APIs that Haystack / deepset publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Files. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 7 operations across 5 paths, and defines 4 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against 2 base URLs: https://api.cloud.deepset.ai, https://api.us.deepset.ai.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Haystack / deepset Files API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— API key generated in the deepset AI Platform UI, sent as a Bearer token.
Paths & Operations 7
Across 5 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Upload, list, delete, and annotate files; manage upload sessions.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are File (5 properties), UploadSession (3 properties), FileList (2 properties), FileUpload (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Haystack / deepset 5
Other APIs Haystack / deepset publishes across the network.