Rossum API Documentation
This is the complete API documentation for connecting to the Rossum API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Rossum: Capture, validate, and automate document workflows with AI. Keep reading to get started.
Quickstart
Before you run your first Rossum request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Rossum connection — create or choose one in Connections. Note its
connectionId.
Every Rossum action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/rossum/latest/actions/{actionSlug}You need a MindCloud API Key and a Rossum connection. Then call an action such as Export Annotations Cross-Queue:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/rossum/latest/actions/export-annotations-cross-queue" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Rossum account that should run the action. MindCloud stores and refreshes the Rossum credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
Rossum actions
All 66 published actions for this Rossum version. Each page documents the endpoint, arguments, and response controls.
- PUTAssign Annotation
- PUTBulk Update Annotation Content
- PUTCancel Validation
- PUTConfirm Annotation
- PUTCopy Annotation
- POSTCreate Annotation
- POSTCreate Document
- POSTCreate Download
- POSTCreate Embedded URL
- POSTCreate Inbox
- POSTCreate Label
- POSTCreate Queue
- POSTCreate Schema
- POSTCreate Upload
- POSTCreate User
- POSTCreate Workspace
- DELETEDelete Document
- DELETEDelete Inbox
- DELETEDelete Label
- DELETEDelete Queue
- DELETEDelete Schema
- DELETEDelete User
- DELETEDelete Workspace
- GETExport Annotations Cross-Queue
- GETExport Queue Annotations
- POSTImport Email
- GETList Annotations
- GETList Documents
- GETList Emails
- GETList Inboxes
- GETList Queues
- GETList Schemas
- GETList User Roles
- GETList Users
- GETList Workspaces
- PUTPostpone Annotation
- PUTReject Annotation
- GETRetrieve Annotation
- GETRetrieve Annotation Content
- GETRetrieve Current User
- GETRetrieve Document
- GETRetrieve Document Content
- GETRetrieve Download
- GETRetrieve Download Content
- GETRetrieve Email
- GETRetrieve Email Content
- GETRetrieve Inbox
- GETRetrieve Queue
- GETRetrieve Related Object Counts
- GETRetrieve Schema
- GETRetrieve Suggested Email Recipients
- GETRetrieve Task
- GETRetrieve Upload
- GETRetrieve User
- GETRetrieve Workspace
- GETSearch Annotations
- PUTStart Validation
- PUTUpdate Annotation
- PUTUpdate Annotation Content
- PUTUpdate Inbox
- PUTUpdate Label
- PUTUpdate Queue
- PUTUpdate Schema
- PUTUpdate User
- PUTUpdate Workspace
- GETValidate Schema
Related apps
More Business Intelligence apps on the Universal API, behind the same REST shape. Or browse all apps.
