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
Affinda

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.

Documentation Provider Profile APIs.io OpenAPI GitHub

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.2.0, at version 3.0.0.

Requests are made against a single base URL, https://{region}.affinda.com.

10 operations 5 paths 35 schemas 2 DELETE5 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0.0
Server
https://{region}.affinda.com
Authentication
HTTP Bearer
Resource Areas
1

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.

Workspaces 10

Operations to manage workspaces. Workspaces group together related collections of documents.

GET
/v3/workspaces
Get list of all workspaces
getAllWorkspaces 2 params → 200400401default
POST
/v3/workspaces
Create a workspace
createWorkspace body → 201400401default
GET
/v3/workspaces/{identifier}
Get specific workspace
getWorkspace 1 param → 200400401default
PATCH
/v3/workspaces/{identifier}
Update a workspace
updateWorkspace 1 param body → 200400401default
DELETE
/v3/workspaces/{identifier}
Delete a workspace
deleteWorkspace 1 param → 204400401default
GET
/v3/workspaces/{identifier}/usagedeprecated
Get usage by workspace
getUsageByWorkspace 3 params → 200400401default
GET
/v3/workspace_memberships
Get list of all workspace memberships
getAllWorkspaceMemberships 4 params → 200400401default
POST
/v3/workspace_memberships
Create a workspace membership
createWorkspaceMembership body → 201400401default
GET
/v3/workspace_memberships/{identifier}
Get specific workspace membership
getWorkspaceMembership 1 param → 200400401default
DELETE
/v3/workspace_memberships/{identifier}
Delete a workspace membership
deleteWorkspaceMembership 1 param → 204400401default

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.

DocumentSplitter_properties-identifier
string
Uniquely identify a document splitter.
properties-id
integer
Uniquely identify a user.
WorkspaceMembershipCreate
object
2 properties
Organization_properties-identifier
string
Uniquely identify an organization.
whitelistIngestAddresses
arraynull
If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. "@eyefind.info".
name
string
Workspace
object
14 properties 1 required
PaletteColorOptions
object
4 properties 1 required
WorkspaceMembership
object
3 properties
rejectInvalidDocuments
boolean
If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed.
UsageByWorkspace
object
Monthly credits consumption
2 properties 2 required
namePlural
string
RejectDuplicates
booleannull
If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false", will parse the document…
ThemeConfig
object
4 properties
WorkspaceMembership_properties-identifier
string
Uniquely identify a membership.
User
object
5 properties
OrganizationRole
string
WorkspaceCreate
object
8 properties 2 required
baseExtractor
objectnull
6 properties 4 required
createdDt
string
Extractor_properties-identifier
string
Uniquely identify an extractor.
UsageByWorkspaceResponse
array
Monthly credits consumption
PaginatedResponse
object
3 properties 1 required
category
stringnull
identifier
string
Uniquely identify a workspace.
unvalidatedDocsCount
integernull
Number of unvalidated documents in the collection.
WorkspaceUpdate
object
7 properties
WorkspaceDocumentSplitter
object
2 properties 2 required
WorkspaceVisibility
string
Visibility "organization" means everyone in the organization can access the workspace. Visibility "private" means only people explicitly added can access the w…
properties-identifier
string
Uniquely identify a collection.
RequestError
object
2 properties 2 required
Organization
object
8 properties
isCustom
boolean
confirmedDocsCount
integernull
Number of validated documents in the collection.
validatable
boolean

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

affinda-workspaces-api-openapi.yml Raw ↑

Other APIs Affinda publishes across the network.

Affinda Documents API
AE Profile APIs.io
Affinda Document Types API
AE Profile APIs.io
Affinda Organizations API
AE Profile APIs.io
Affinda Data Sources API
AE Profile APIs.io
Affinda Annotations API
AE Profile APIs.io
Affinda Validation Results API
AE Profile APIs.io
Affinda Tags API
AE Profile APIs.io
Affinda Usage API
AE Profile APIs.io
Affinda Webhooks API
AE Profile APIs.io
Affinda Search and Match API
AE Profile APIs.io
Affinda Add x-hidden to endpoints API
AE Profile APIs.io
Affinda Deprecated End Points API
AE Profile APIs.io
#Workspaces#Organization#Permissions
← Back to A APIs
API Details
ID
affinda:affinda-workspaces-api
Server
https://{region}.affinda.com
Docs
https://docs.affinda.com/reference/workspaces
Provider
Affinda
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=affinda-workspaces-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/affinda-workspaces-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 Affinda Workspaces 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.