# Rossum API Documentation

This is the complete API documentation for connecting to the Rossum API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **Rossum connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

```text
POST https://connect.mindcloud.co/v2/universal/apps/rossum/actions/{actionSlug}/run
```

## Rossum actions

- PUT `assign-annotation` Assign Annotation
- PUT `bulk-update-annotation-content` Bulk Update Annotation Content
- PUT `cancel-validation` Cancel Validation
- PUT `confirm-annotation` Confirm Annotation
- PUT `copy-annotation` Copy Annotation
- POST `create-annotation` Create Annotation
- POST `create-document` Create Document
- POST `create-download` Create Download
- POST `create-embedded-url` Create Embedded URL
- POST `create-inbox` Create Inbox
- POST `create-label` Create Label
- POST `create-queue` Create Queue
- POST `create-schema` Create Schema
- POST `create-upload` Create Upload
- POST `create-user` Create User
- POST `create-workspace` Create Workspace
- DELETE `delete-document` Delete Document
- DELETE `delete-inbox` Delete Inbox
- DELETE `delete-label` Delete Label
- DELETE `delete-queue` Delete Queue
- DELETE `delete-schema` Delete Schema
- DELETE `delete-user` Delete User
- DELETE `delete-workspace` Delete Workspace
- GET `export-annotations-cross-queue` Export Annotations Cross-Queue
- GET `export-queue-annotations` Export Queue Annotations
- POST `import-email` Import Email
- GET `list-annotations` List Annotations
- GET `list-documents` List Documents
- GET `list-emails` List Emails
- GET `list-inboxes` List Inboxes
- GET `list-queues` List Queues
- GET `list-schemas` List Schemas
- GET `list-user-roles` List User Roles
- GET `list-users` List Users
- GET `list-workspaces` List Workspaces
- PUT `postpone-annotation` Postpone Annotation
- PUT `reject-annotation` Reject Annotation
- GET `retrieve-annotation` Retrieve Annotation
- GET `retrieve-annotation-content` Retrieve Annotation Content
- GET `retrieve-current-user` Retrieve Current User
- GET `retrieve-document` Retrieve Document
- GET `retrieve-document-content` Retrieve Document Content
- GET `retrieve-download` Retrieve Download
- GET `retrieve-download-content` Retrieve Download Content
- GET `retrieve-email` Retrieve Email
- GET `retrieve-email-content` Retrieve Email Content
- GET `retrieve-inbox` Retrieve Inbox
- GET `retrieve-queue` Retrieve Queue
- GET `retrieve-related-object-counts` Retrieve Related Object Counts
- GET `retrieve-schema` Retrieve Schema
- GET `retrieve-suggested-email-recipients` Retrieve Suggested Email Recipients
- GET `retrieve-task` Retrieve Task
- GET `retrieve-upload` Retrieve Upload
- GET `retrieve-user` Retrieve User
- GET `retrieve-workspace` Retrieve Workspace
- GET `search-annotations` Search Annotations
- PUT `start-validation` Start Validation
- PUT `update-annotation` Update Annotation
- PUT `update-annotation-content` Update Annotation Content
- PUT `update-inbox` Update Inbox
- PUT `update-label` Update Label
- PUT `update-queue` Update Queue
- PUT `update-schema` Update Schema
- PUT `update-user` Update User
- PUT `update-workspace` Update Workspace
- GET `validate-schema` Validate Schema