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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Haystack / deepset

Haystack / deepset Files API

Upload, list, delete, and annotate files; manage upload sessions.

Documentation Provider Profile APIs.io OpenAPI GitHub

Haystack / deepset Files API is one of 10 APIs that Haystack / deepset 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, API documentation, and an API reference.

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

Requests are made against 2 base URLs: https://api.cloud.deepset.ai, https://api.us.deepset.ai.

7 operations 5 paths 4 schemas 1 DELETE2 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://github.com/deepset-ai/haystack
Authentication
HTTP Bearer
Contact
deepset Support
Terms of Service
View terms
Resource Areas
1

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.

Files 7

Upload, list, delete, and annotate files; manage upload sessions.

GET
/api/v1/workspaces/{workspace_name}/files
List files
listFiles 2 params → 200
POST
/api/v1/workspaces/{workspace_name}/files
Upload a file
uploadFile 2 params body → 201
DELETE
/api/v1/workspaces/{workspace_name}/files/{file_id}
Delete a file
deleteFile 2 params → 204
PATCH
/api/v1/workspaces/{workspace_name}/files/{file_id}/meta
Update file metadata
updateFileMeta 2 params body → 200
POST
/api/v1/workspaces/{workspace_name}/upload_sessions
Create an upload session
createUploadSession 1 param → 201
GET
/api/v1/workspaces/{workspace_name}/upload_sessions/{session_id}
Get upload session details
getUploadSession 2 params → 200
PUT
/api/v1/workspaces/{workspace_name}/upload_sessions/{session_id}
Close an upload session
closeUploadSession 2 params body → 200

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.

File
object
5 properties
UploadSession
object
3 properties
FileUpload
object
2 properties
FileList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haystack-ai-files-api-openapi.yml Raw ↑

Other APIs Haystack / deepset publishes across the network.

Haystack Framework (Open Source)
AE Profile APIs.io
Hayhooks REST Deployment
AE Profile APIs.io
Haystack / deepset Pipelines API
AE Profile APIs.io
Haystack / deepset Search API
AE Profile APIs.io
Haystack / deepset Workspaces API
AE Profile APIs.io
Haystack Config API
AE Profile APIs.io
Haystack Dashboard API
AE Profile APIs.io
Haystack Openai API
AE Profile APIs.io
Haystack Status API
AE Profile APIs.io
#File
← Back to H APIs
API Details
ID
haystack-ai:haystack-ai-files-api
Base URL
https://github.com/deepset-ai/haystack
Docs
https://docs.haystack.deepset.ai/docs/intro
Provider
Haystack / deepset
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=haystack-ai-files-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/haystack-ai-files-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Haystack / deepset 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.