Annotation31

Annotation Content9

Audit Log1

Automation Blocker2

Configuration Changelog1

Connector6

Dedicated Engine7

Dedicated Engine Schema8

Delete Recommendation6

Document7

Document Relation6

Documents Download3

Email7

Email Template7

Email Thread4

Engine9

Engine Field7

Generic Engine2

Generic Engine Schema2

Hook12

Hook Run3

Hook Template2

Inbox6

Integration Credential2

Label7

Membership6

Organization11

Organization Group14

Page2

Queue15

Relation6

Rule6

Rules Execution Log1

Saved View6

Schema8

Suggested Edit6

Task1

Trigger6

Upload3

User13

User Role2

Workflow2

Workflow Activity2

Workflow Run3

Workflow Step2

Workspace6

Queue

Start validation

<Callout type="warn"> This endpoint is INTERNAL and may change in the future. </Callout>

Start reviewing the next available annotation from the queue by the calling user.

post/api/v1/queues/{id}/next

Request

Base URL
https://example.rossum.app
Auth
HTTP bearer
TypeScript
https://skmtc.dev/rossum/apis/rossum-api/docs/api/v1/queues/:id/next/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

Queue ID

Request body

annotation_idsinteger[]

List of annotation ids to select from (optional).

statusesstring[]

List of allowed statuses (optional).

Response

annotationstring uri nullable

URL of started annotation. If there is no annotation to start, this will be null.

session_timeoutstring

Session timeout in format HH:MM:SS.

Changes

No recorded changes to this operation across all 14 revisions of this API.