Affinda Workspaces API
Workspaces group together related collections, documents, members, and webhook subscriptions. Workspace identifiers scope every document upload, listing, and webhook delivery. Includes per-workspace usage reporting for credits and pages processed.
Affinda Workspaces API is one of 16 APIs that Affinda publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Workspaces, Organization, and Permissions. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.
This API exposes 10 operations across 5 paths, and defines 35 schemas. It is described by OpenAPI 3.0.3, at version 3.0.0.
Requests are made against a single base URL, https://{region}.affinda.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Affinda Workspaces API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— Basic authentication using an API key, e.g. {Authorization: Bearer aff0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings pag…
Paths & Operations 10
Across 5 paths, the API surfaces 10 operations — 2 DELETE, 5 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Operations to manage workspaces. Workspaces group together related collections of documents.
Schemas 35
The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are Workspace (14 properties), WorkspaceCreate (8 properties), Organization (8 properties), WorkspaceUpdate (7 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 Affinda 12
Other APIs Affinda publishes across the network.