Haystack / deepset Workspaces API
Manage workspaces that isolate pipelines and data.
Haystack / deepset Workspaces 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 Workspaces. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 4 operations across 2 paths, and defines 3 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 Workspaces 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 4
Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Manage workspaces that isolate pipelines and data.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Workspace (3 properties), WorkspaceList (2 properties), CreateWorkspaceRequest (1 property). 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.