Queue
A queue object represents a basic organization unit of annotations. Annotations are imported to a queue either through a REST API upload endpoint or by sending an email to a related inbox Export is also performed on a queue using export endpoint.
Queue also specifies a schema for annotations and a connector
Annotators and viewers only see queues they are assigned to.
Queue
ID of the queue.
Name of the queue (max. 255 characters).
maxLength: 255URL of the queue.
Workspace in which the queue should be placed (it can be set to null, but bare in mind that it will make the queue invisible in the Rossum UI and it may cause some unexpected consequences).
Connector associated with the queue.
Default:null(Deprecated) Webhooks associated with the queue (serves as an alias for hooks attribute).
[]Hooks associated with the queue.
Default:[]Schema which will be applied to annotations in this queue.
Inbox for import to this queue.
Default:nullUsers associated with this queue.
Default:[]Time before annotation will be returned from reviewing status to to_review (timeout is evaluated every 10 minutes).
"01:00:00"(Deprecated) Use generic_engine or dedicated_engine to set AI Core Engine.
nullURL parameters to be passed to the AI Core Engine. More specific AI Core Engine parameters influencing the extraction may be set using this field.
Publicly available parameters:
effective_page_count(int): Limits the extraction to the firsteffective_page_countpages of the document. Useful to prevent data extraction from additional pages of unrelated, but included documents. Default: 32 (pages to be extracted from a document).tables(boolean): Allows disabling line item data extraction. Useful to speed up data extraction when line item details are not required, especially on long documents with large tables. Default: true (line items are being extracted).
nullDedicated engine used for processing documents uploaded to this queue. If dedicated_engine is set generic_engine must be null. If both engines are null, a default generic one gets set.
nullGeneric engine used for processing documents uploaded to this queue. If generic_engine is set dedicated_engine must be null. If both engines are null, a default generic one gets set.
nullThreshold used to automatically validate field content based on AI confidence scores.
min: 0, max: 1Default:0.8Toggle for switching automation on/off.
Default:falseSet level of automation. always - Auto-export all documents with no validation errors. When there is an error triggered for a non-required field, such values are deleted and export is re-tried. confident - Auto-export documents with at least one validation source and no validation errors. never - Annotation is not automatically exported and must be validated in UI manually.
"never"Typical originating region of documents processed in this queue specified in the locale format. If auto option is chosen, the locale will be detected automatically if the organization group has access to Aurora engine. Otherwise, default option (en_GB) will be used.
The locale field is a hint for the AI Engine on how to resolve some ambiguous cases during data extraction, concerning e.g. date formats or decimal separators that may depend on the locale. For example, in US the typical date format is mm/dd/yyyy whilst in Europe it is dd.mm.yyyy. A date such as "12. 6. 2018" will be extracted as Jun 12 when locale is en_GB, while the same date will be extracted as Dec 6 when locale is en_US.
"en_GB"Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Affects exporting - when true, confirm endpoint transitions annotation to confirmed status instead to exporting.
falseData retention period -- annotations will be automatically purged this time after their creation. The format of the value is '[DD] [HH:[MM:]]ss[.uuuuuu]', e.g. 90 days retention can be set as '90 00:00:00'. Please keep in mind that purging documents in Rossum can limit its learning capabilities. This is a priced feature and has no effect unless enabled.
Default:nullCurrent status of the queue. active - This is the default status. Queue is usable. deletion_requested - Queue is marked for deletion (by calling DELETE /v1/queues/<id>). Will be asynchronously deleted after delete_after. deletion_in_progress - Queue is currently being deleted. When a queue has this status some raise conditions may occur as the related objects are being gradually deleted. deletion_failed - Something wrong happened in the process of queue deletion. The queue may be in an inconsistent state.
Please note, that document import (via upload as well as email) is disabled while the queue status is one of deletion_requested, deletion_in_progress, deletion_failed.
"active"User that last modified the object.
Timestamp of last modification.
List queues
Retrieve all queue objects.
curl -X GET "https://example.rossum.app/api/v1/queues?id=1%2C2%2C3"{
"pagination": {
"total": 1,
"total_pages": 1,
"next": null,
"previous": null
},
"results": [
{
"id": 8198,
"name": "Received invoices",
"url": "https://example.rossum.app/api/v1/queues/8198",
"workspace": "https://example.rossum.app/api/v1/workspaces/7540",
"connector": null,
"webhooks": [],
"hooks": [],
"schema": "https://example.rossum.app/api/v1/schemas/31336",
"inbox": "https://example.rossum.app/api/v1/inboxes/1229",
"users": [
"https://example.rossum.app/api/v1/users/10775"
],
"session_timeout": "01:00:00",
"rir_url": null,
"rir_params": null,
"dedicated_engine": null,
"generic_engine": "https://example.rossum.app/api/v1/generic_engines/3000",
"counts": {
"importing": 0,
"split": 0,
"failed_import": 0,
"to_review": 2,
"reviewing": 0,
"confirmed": 0,
"exporting": 0,
"postponed": 0,
"failed_export": 0,
"exported": 0,
"deleted": 0,
"purged": 0,
"rejected": 0
},
"default_score_threshold": 0.8,
"automation_enabled": false,
"automation_level": "never",
"locale": "en_US",
"metadata": {
"some_key": "some_value"
},
"use_confirmed_state": false,
"document_lifetime": "01:00:00",
"status": "active",
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"settings": {},
"workflows": []
}
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Create queue
Create a new queue object.
curl -X POST "https://example.rossum.app/api/v1/queues" \ -H "Content-Type: application/json" \ -d '{ "name": "Received invoices", "schema": "https://example.rossum.app/api/v1/schemas/31336" }'{
"id": 8198,
"name": "Received invoices",
"url": "https://example.rossum.app/api/v1/queues/8198",
"workspace": "https://example.rossum.app/api/v1/workspaces/7540",
"connector": null,
"webhooks": [],
"hooks": [],
"schema": "https://example.rossum.app/api/v1/schemas/31336",
"inbox": "https://example.rossum.app/api/v1/inboxes/1229",
"users": [
"https://example.rossum.app/api/v1/users/10775"
],
"session_timeout": "01:00:00",
"rir_url": null,
"rir_params": null,
"dedicated_engine": null,
"generic_engine": "https://example.rossum.app/api/v1/generic_engines/3000",
"counts": {
"importing": 0,
"split": 0,
"failed_import": 0,
"to_review": 2,
"reviewing": 0,
"confirmed": 0,
"exporting": 0,
"postponed": 0,
"failed_export": 0,
"exported": 0,
"deleted": 0,
"purged": 0,
"rejected": 0
},
"default_score_threshold": 0.8,
"automation_enabled": false,
"automation_level": "never",
"locale": "en_US",
"metadata": {
"some_key": "some_value"
},
"use_confirmed_state": false,
"document_lifetime": "01:00:00",
"status": "active",
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"settings": {},
"workflows": []
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
Name of the queue (max. 255 characters).
maxLength: 255Workspace in which the queue should be placed (it can be set to null, but bare in mind that it will make the queue invisible in the Rossum UI and it may cause some unexpected consequences).
Connector associated with the queue.
Default:null(Deprecated) Webhooks associated with the queue (serves as an alias for hooks attribute).
[]Hooks associated with the queue.
Default:[]Schema which will be applied to annotations in this queue.
Inbox for import to this queue.
Default:nullUsers associated with this queue.
Default:[]Time before annotation will be returned from reviewing status to to_review (timeout is evaluated every 10 minutes).
"01:00:00"(Deprecated) Use generic_engine or dedicated_engine to set AI Core Engine.
nullURL parameters to be passed to the AI Core Engine. More specific AI Core Engine parameters influencing the extraction may be set using this field.
Publicly available parameters:
effective_page_count(int): Limits the extraction to the firsteffective_page_countpages of the document. Useful to prevent data extraction from additional pages of unrelated, but included documents. Default: 32 (pages to be extracted from a document).tables(boolean): Allows disabling line item data extraction. Useful to speed up data extraction when line item details are not required, especially on long documents with large tables. Default: true (line items are being extracted).
nullDedicated engine used for processing documents uploaded to this queue. If dedicated_engine is set generic_engine must be null. If both engines are null, a default generic one gets set.
nullGeneric engine used for processing documents uploaded to this queue. If generic_engine is set dedicated_engine must be null. If both engines are null, a default generic one gets set.
nullThreshold used to automatically validate field content based on AI confidence scores.
min: 0, max: 1Default:0.8Toggle for switching automation on/off.
Default:falseSet level of automation. always - Auto-export all documents with no validation errors. When there is an error triggered for a non-required field, such values are deleted and export is re-tried. confident - Auto-export documents with at least one validation source and no validation errors. never - Annotation is not automatically exported and must be validated in UI manually.
"never"Typical originating region of documents processed in this queue specified in the locale format. If auto option is chosen, the locale will be detected automatically if the organization group has access to Aurora engine. Otherwise, default option (en_GB) will be used.
The locale field is a hint for the AI Engine on how to resolve some ambiguous cases during data extraction, concerning e.g. date formats or decimal separators that may depend on the locale. For example, in US the typical date format is mm/dd/yyyy whilst in Europe it is dd.mm.yyyy. A date such as "12. 6. 2018" will be extracted as Jun 12 when locale is en_GB, while the same date will be extracted as Dec 6 when locale is en_US.
"en_GB"Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Affects exporting - when true, confirm endpoint transitions annotation to confirmed status instead to exporting.
falseData retention period -- annotations will be automatically purged this time after their creation. The format of the value is '[DD] [HH:[MM:]]ss[.uuuuuu]', e.g. 90 days retention can be set as '90 00:00:00'. Please keep in mind that purging documents in Rossum can limit its learning capabilities. This is a priced feature and has no effect unless enabled.
Default:nullResponse
Created
ID of the queue.
Name of the queue (max. 255 characters).
maxLength: 255URL of the queue.
Workspace in which the queue should be placed (it can be set to null, but bare in mind that it will make the queue invisible in the Rossum UI and it may cause some unexpected consequences).
Connector associated with the queue.
Default:null(Deprecated) Webhooks associated with the queue (serves as an alias for hooks attribute).
[]Hooks associated with the queue.
Default:[]Schema which will be applied to annotations in this queue.
Inbox for import to this queue.
Default:nullUsers associated with this queue.
Default:[]Time before annotation will be returned from reviewing status to to_review (timeout is evaluated every 10 minutes).
"01:00:00"(Deprecated) Use generic_engine or dedicated_engine to set AI Core Engine.
nullURL parameters to be passed to the AI Core Engine. More specific AI Core Engine parameters influencing the extraction may be set using this field.
Publicly available parameters:
effective_page_count(int): Limits the extraction to the firsteffective_page_countpages of the document. Useful to prevent data extraction from additional pages of unrelated, but included documents. Default: 32 (pages to be extracted from a document).tables(boolean): Allows disabling line item data extraction. Useful to speed up data extraction when line item details are not required, especially on long documents with large tables. Default: true (line items are being extracted).
nullDedicated engine used for processing documents uploaded to this queue. If dedicated_engine is set generic_engine must be null. If both engines are null, a default generic one gets set.
nullGeneric engine used for processing documents uploaded to this queue. If generic_engine is set dedicated_engine must be null. If both engines are null, a default generic one gets set.
nullThreshold used to automatically validate field content based on AI confidence scores.
min: 0, max: 1Default:0.8Toggle for switching automation on/off.
Default:falseSet level of automation. always - Auto-export all documents with no validation errors. When there is an error triggered for a non-required field, such values are deleted and export is re-tried. confident - Auto-export documents with at least one validation source and no validation errors. never - Annotation is not automatically exported and must be validated in UI manually.
"never"Typical originating region of documents processed in this queue specified in the locale format. If auto option is chosen, the locale will be detected automatically if the organization group has access to Aurora engine. Otherwise, default option (en_GB) will be used.
The locale field is a hint for the AI Engine on how to resolve some ambiguous cases during data extraction, concerning e.g. date formats or decimal separators that may depend on the locale. For example, in US the typical date format is mm/dd/yyyy whilst in Europe it is dd.mm.yyyy. A date such as "12. 6. 2018" will be extracted as Jun 12 when locale is en_GB, while the same date will be extracted as Dec 6 when locale is en_US.
"en_GB"Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Affects exporting - when true, confirm endpoint transitions annotation to confirmed status instead to exporting.
falseData retention period -- annotations will be automatically purged this time after their creation. The format of the value is '[DD] [HH:[MM:]]ss[.uuuuuu]', e.g. 90 days retention can be set as '90 00:00:00'. Please keep in mind that purging documents in Rossum can limit its learning capabilities. This is a priced feature and has no effect unless enabled.
Default:nullCurrent status of the queue. active - This is the default status. Queue is usable. deletion_requested - Queue is marked for deletion (by calling DELETE /v1/queues/<id>). Will be asynchronously deleted after delete_after. deletion_in_progress - Queue is currently being deleted. When a queue has this status some raise conditions may occur as the related objects are being gradually deleted. deletion_failed - Something wrong happened in the process of queue deletion. The queue may be in an inconsistent state.
Please note, that document import (via upload as well as email) is disabled while the queue status is one of deletion_requested, deletion_in_progress, deletion_failed.
"active"User that last modified the object.
Timestamp of last modification.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Retrieve queue
Get a queue object.
curl -X GET "https://example.rossum.app/api/v1/queues/0"{
"id": 8198,
"name": "Received invoices",
"url": "https://example.rossum.app/api/v1/queues/8198",
"workspace": "https://example.rossum.app/api/v1/workspaces/7540",
"connector": null,
"webhooks": [],
"hooks": [],
"schema": "https://example.rossum.app/api/v1/schemas/31336",
"inbox": "https://example.rossum.app/api/v1/inboxes/1229",
"users": [
"https://example.rossum.app/api/v1/users/10775"
],
"session_timeout": "01:00:00",
"rir_url": null,
"rir_params": null,
"dedicated_engine": null,
"generic_engine": "https://example.rossum.app/api/v1/generic_engines/3000",
"counts": {
"importing": 0,
"split": 0,
"failed_import": 0,
"to_review": 2,
"reviewing": 0,
"confirmed": 0,
"exporting": 0,
"postponed": 0,
"failed_export": 0,
"exported": 0,
"deleted": 0,
"purged": 0,
"rejected": 0
},
"default_score_threshold": 0.8,
"automation_enabled": false,
"automation_level": "never",
"locale": "en_US",
"metadata": {
"some_key": "some_value"
},
"use_confirmed_state": false,
"document_lifetime": "01:00:00",
"status": "active",
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"settings": {},
"workflows": []
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
ID of the queue.
Name of the queue (max. 255 characters).
maxLength: 255URL of the queue.
Workspace in which the queue should be placed (it can be set to null, but bare in mind that it will make the queue invisible in the Rossum UI and it may cause some unexpected consequences).
Connector associated with the queue.
Default:null(Deprecated) Webhooks associated with the queue (serves as an alias for hooks attribute).
[]Hooks associated with the queue.
Default:[]Schema which will be applied to annotations in this queue.
Inbox for import to this queue.
Default:nullUsers associated with this queue.
Default:[]Time before annotation will be returned from reviewing status to to_review (timeout is evaluated every 10 minutes).
"01:00:00"(Deprecated) Use generic_engine or dedicated_engine to set AI Core Engine.
nullURL parameters to be passed to the AI Core Engine. More specific AI Core Engine parameters influencing the extraction may be set using this field.
Publicly available parameters:
effective_page_count(int): Limits the extraction to the firsteffective_page_countpages of the document. Useful to prevent data extraction from additional pages of unrelated, but included documents. Default: 32 (pages to be extracted from a document).tables(boolean): Allows disabling line item data extraction. Useful to speed up data extraction when line item details are not required, especially on long documents with large tables. Default: true (line items are being extracted).
nullDedicated engine used for processing documents uploaded to this queue. If dedicated_engine is set generic_engine must be null. If both engines are null, a default generic one gets set.
nullGeneric engine used for processing documents uploaded to this queue. If generic_engine is set dedicated_engine must be null. If both engines are null, a default generic one gets set.
nullThreshold used to automatically validate field content based on AI confidence scores.
min: 0, max: 1Default:0.8Toggle for switching automation on/off.
Default:falseSet level of automation. always - Auto-export all documents with no validation errors. When there is an error triggered for a non-required field, such values are deleted and export is re-tried. confident - Auto-export documents with at least one validation source and no validation errors. never - Annotation is not automatically exported and must be validated in UI manually.
"never"Typical originating region of documents processed in this queue specified in the locale format. If auto option is chosen, the locale will be detected automatically if the organization group has access to Aurora engine. Otherwise, default option (en_GB) will be used.
The locale field is a hint for the AI Engine on how to resolve some ambiguous cases during data extraction, concerning e.g. date formats or decimal separators that may depend on the locale. For example, in US the typical date format is mm/dd/yyyy whilst in Europe it is dd.mm.yyyy. A date such as "12. 6. 2018" will be extracted as Jun 12 when locale is en_GB, while the same date will be extracted as Dec 6 when locale is en_US.
"en_GB"Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Affects exporting - when true, confirm endpoint transitions annotation to confirmed status instead to exporting.
falseData retention period -- annotations will be automatically purged this time after their creation. The format of the value is '[DD] [HH:[MM:]]ss[.uuuuuu]', e.g. 90 days retention can be set as '90 00:00:00'. Please keep in mind that purging documents in Rossum can limit its learning capabilities. This is a priced feature and has no effect unless enabled.
Default:nullCurrent status of the queue. active - This is the default status. Queue is usable. deletion_requested - Queue is marked for deletion (by calling DELETE /v1/queues/<id>). Will be asynchronously deleted after delete_after. deletion_in_progress - Queue is currently being deleted. When a queue has this status some raise conditions may occur as the related objects are being gradually deleted. deletion_failed - Something wrong happened in the process of queue deletion. The queue may be in an inconsistent state.
Please note, that document import (via upload as well as email) is disabled while the queue status is one of deletion_requested, deletion_in_progress, deletion_failed.
"active"User that last modified the object.
Timestamp of last modification.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Partial update queue
Update part of queue object.
curl -X PATCH "https://example.rossum.app/api/v1/queues/0" \ -H "Content-Type: application/json" \ -d '{}'{
"id": 8198,
"name": "Received invoices",
"url": "https://example.rossum.app/api/v1/queues/8198",
"workspace": "https://example.rossum.app/api/v1/workspaces/7540",
"connector": null,
"webhooks": [],
"hooks": [],
"schema": "https://example.rossum.app/api/v1/schemas/31336",
"inbox": "https://example.rossum.app/api/v1/inboxes/1229",
"users": [
"https://example.rossum.app/api/v1/users/10775"
],
"session_timeout": "01:00:00",
"rir_url": null,
"rir_params": null,
"dedicated_engine": null,
"generic_engine": "https://example.rossum.app/api/v1/generic_engines/3000",
"counts": {
"importing": 0,
"split": 0,
"failed_import": 0,
"to_review": 2,
"reviewing": 0,
"confirmed": 0,
"exporting": 0,
"postponed": 0,
"failed_export": 0,
"exported": 0,
"deleted": 0,
"purged": 0,
"rejected": 0
},
"default_score_threshold": 0.8,
"automation_enabled": false,
"automation_level": "never",
"locale": "en_US",
"metadata": {
"some_key": "some_value"
},
"use_confirmed_state": false,
"document_lifetime": "01:00:00",
"status": "active",
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"settings": {},
"workflows": []
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
Name of the queue (max. 255 characters).
maxLength: 255Workspace in which the queue should be placed (it can be set to null, but bare in mind that it will make the queue invisible in the Rossum UI and it may cause some unexpected consequences).
Connector associated with the queue.
Default:null(Deprecated) Webhooks associated with the queue (serves as an alias for hooks attribute).
[]Hooks associated with the queue.
Default:[]Schema which will be applied to annotations in this queue.
Inbox for import to this queue.
Default:nullUsers associated with this queue.
Default:[]Time before annotation will be returned from reviewing status to to_review (timeout is evaluated every 10 minutes).
"01:00:00"(Deprecated) Use generic_engine or dedicated_engine to set AI Core Engine.
nullURL parameters to be passed to the AI Core Engine. More specific AI Core Engine parameters influencing the extraction may be set using this field.
Publicly available parameters:
effective_page_count(int): Limits the extraction to the firsteffective_page_countpages of the document. Useful to prevent data extraction from additional pages of unrelated, but included documents. Default: 32 (pages to be extracted from a document).tables(boolean): Allows disabling line item data extraction. Useful to speed up data extraction when line item details are not required, especially on long documents with large tables. Default: true (line items are being extracted).
nullDedicated engine used for processing documents uploaded to this queue. If dedicated_engine is set generic_engine must be null. If both engines are null, a default generic one gets set.
nullGeneric engine used for processing documents uploaded to this queue. If generic_engine is set dedicated_engine must be null. If both engines are null, a default generic one gets set.
nullThreshold used to automatically validate field content based on AI confidence scores.
min: 0, max: 1Default:0.8Toggle for switching automation on/off.
Default:falseSet level of automation. always - Auto-export all documents with no validation errors. When there is an error triggered for a non-required field, such values are deleted and export is re-tried. confident - Auto-export documents with at least one validation source and no validation errors. never - Annotation is not automatically exported and must be validated in UI manually.
"never"Typical originating region of documents processed in this queue specified in the locale format. If auto option is chosen, the locale will be detected automatically if the organization group has access to Aurora engine. Otherwise, default option (en_GB) will be used.
The locale field is a hint for the AI Engine on how to resolve some ambiguous cases during data extraction, concerning e.g. date formats or decimal separators that may depend on the locale. For example, in US the typical date format is mm/dd/yyyy whilst in Europe it is dd.mm.yyyy. A date such as "12. 6. 2018" will be extracted as Jun 12 when locale is en_GB, while the same date will be extracted as Dec 6 when locale is en_US.
"en_GB"Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Affects exporting - when true, confirm endpoint transitions annotation to confirmed status instead to exporting.
falseData retention period -- annotations will be automatically purged this time after their creation. The format of the value is '[DD] [HH:[MM:]]ss[.uuuuuu]', e.g. 90 days retention can be set as '90 00:00:00'. Please keep in mind that purging documents in Rossum can limit its learning capabilities. This is a priced feature and has no effect unless enabled.
Default:nullResponse
OK
ID of the queue.
Name of the queue (max. 255 characters).
maxLength: 255URL of the queue.
Workspace in which the queue should be placed (it can be set to null, but bare in mind that it will make the queue invisible in the Rossum UI and it may cause some unexpected consequences).
Connector associated with the queue.
Default:null(Deprecated) Webhooks associated with the queue (serves as an alias for hooks attribute).
[]Hooks associated with the queue.
Default:[]Schema which will be applied to annotations in this queue.
Inbox for import to this queue.
Default:nullUsers associated with this queue.
Default:[]Time before annotation will be returned from reviewing status to to_review (timeout is evaluated every 10 minutes).
"01:00:00"(Deprecated) Use generic_engine or dedicated_engine to set AI Core Engine.
nullURL parameters to be passed to the AI Core Engine. More specific AI Core Engine parameters influencing the extraction may be set using this field.
Publicly available parameters:
effective_page_count(int): Limits the extraction to the firsteffective_page_countpages of the document. Useful to prevent data extraction from additional pages of unrelated, but included documents. Default: 32 (pages to be extracted from a document).tables(boolean): Allows disabling line item data extraction. Useful to speed up data extraction when line item details are not required, especially on long documents with large tables. Default: true (line items are being extracted).
nullDedicated engine used for processing documents uploaded to this queue. If dedicated_engine is set generic_engine must be null. If both engines are null, a default generic one gets set.
nullGeneric engine used for processing documents uploaded to this queue. If generic_engine is set dedicated_engine must be null. If both engines are null, a default generic one gets set.
nullThreshold used to automatically validate field content based on AI confidence scores.
min: 0, max: 1Default:0.8Toggle for switching automation on/off.
Default:falseSet level of automation. always - Auto-export all documents with no validation errors. When there is an error triggered for a non-required field, such values are deleted and export is re-tried. confident - Auto-export documents with at least one validation source and no validation errors. never - Annotation is not automatically exported and must be validated in UI manually.
"never"Typical originating region of documents processed in this queue specified in the locale format. If auto option is chosen, the locale will be detected automatically if the organization group has access to Aurora engine. Otherwise, default option (en_GB) will be used.
The locale field is a hint for the AI Engine on how to resolve some ambiguous cases during data extraction, concerning e.g. date formats or decimal separators that may depend on the locale. For example, in US the typical date format is mm/dd/yyyy whilst in Europe it is dd.mm.yyyy. A date such as "12. 6. 2018" will be extracted as Jun 12 when locale is en_GB, while the same date will be extracted as Dec 6 when locale is en_US.
"en_GB"Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Affects exporting - when true, confirm endpoint transitions annotation to confirmed status instead to exporting.
falseData retention period -- annotations will be automatically purged this time after their creation. The format of the value is '[DD] [HH:[MM:]]ss[.uuuuuu]', e.g. 90 days retention can be set as '90 00:00:00'. Please keep in mind that purging documents in Rossum can limit its learning capabilities. This is a priced feature and has no effect unless enabled.
Default:nullCurrent status of the queue. active - This is the default status. Queue is usable. deletion_requested - Queue is marked for deletion (by calling DELETE /v1/queues/<id>). Will be asynchronously deleted after delete_after. deletion_in_progress - Queue is currently being deleted. When a queue has this status some raise conditions may occur as the related objects are being gradually deleted. deletion_failed - Something wrong happened in the process of queue deletion. The queue may be in an inconsistent state.
Please note, that document import (via upload as well as email) is disabled while the queue status is one of deletion_requested, deletion_in_progress, deletion_failed.
"active"User that last modified the object.
Timestamp of last modification.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Delete queue
Delete queue object. Calling this endpoint will schedule the queue to be asynchronously deleted.
curl -X DELETE "https://example.rossum.app/api/v1/queues/0"{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
Accepted
No response body.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Update queue
Update queue object.
curl -X PUT "https://example.rossum.app/api/v1/queues/0" \ -H "Content-Type: application/json" \ -d '{ "name": "Received invoices", "schema": "https://example.rossum.app/api/v1/schemas/31336" }'{
"id": 8198,
"name": "Received invoices",
"url": "https://example.rossum.app/api/v1/queues/8198",
"workspace": "https://example.rossum.app/api/v1/workspaces/7540",
"connector": null,
"webhooks": [],
"hooks": [],
"schema": "https://example.rossum.app/api/v1/schemas/31336",
"inbox": "https://example.rossum.app/api/v1/inboxes/1229",
"users": [
"https://example.rossum.app/api/v1/users/10775"
],
"session_timeout": "01:00:00",
"rir_url": null,
"rir_params": null,
"dedicated_engine": null,
"generic_engine": "https://example.rossum.app/api/v1/generic_engines/3000",
"counts": {
"importing": 0,
"split": 0,
"failed_import": 0,
"to_review": 2,
"reviewing": 0,
"confirmed": 0,
"exporting": 0,
"postponed": 0,
"failed_export": 0,
"exported": 0,
"deleted": 0,
"purged": 0,
"rejected": 0
},
"default_score_threshold": 0.8,
"automation_enabled": false,
"automation_level": "never",
"locale": "en_US",
"metadata": {
"some_key": "some_value"
},
"use_confirmed_state": false,
"document_lifetime": "01:00:00",
"status": "active",
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"settings": {},
"workflows": []
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
Name of the queue (max. 255 characters).
maxLength: 255Workspace in which the queue should be placed (it can be set to null, but bare in mind that it will make the queue invisible in the Rossum UI and it may cause some unexpected consequences).
Connector associated with the queue.
Default:null(Deprecated) Webhooks associated with the queue (serves as an alias for hooks attribute).
[]Hooks associated with the queue.
Default:[]Schema which will be applied to annotations in this queue.
Inbox for import to this queue.
Default:nullUsers associated with this queue.
Default:[]Time before annotation will be returned from reviewing status to to_review (timeout is evaluated every 10 minutes).
"01:00:00"(Deprecated) Use generic_engine or dedicated_engine to set AI Core Engine.
nullURL parameters to be passed to the AI Core Engine. More specific AI Core Engine parameters influencing the extraction may be set using this field.
Publicly available parameters:
effective_page_count(int): Limits the extraction to the firsteffective_page_countpages of the document. Useful to prevent data extraction from additional pages of unrelated, but included documents. Default: 32 (pages to be extracted from a document).tables(boolean): Allows disabling line item data extraction. Useful to speed up data extraction when line item details are not required, especially on long documents with large tables. Default: true (line items are being extracted).
nullDedicated engine used for processing documents uploaded to this queue. If dedicated_engine is set generic_engine must be null. If both engines are null, a default generic one gets set.
nullGeneric engine used for processing documents uploaded to this queue. If generic_engine is set dedicated_engine must be null. If both engines are null, a default generic one gets set.
nullThreshold used to automatically validate field content based on AI confidence scores.
min: 0, max: 1Default:0.8Toggle for switching automation on/off.
Default:falseSet level of automation. always - Auto-export all documents with no validation errors. When there is an error triggered for a non-required field, such values are deleted and export is re-tried. confident - Auto-export documents with at least one validation source and no validation errors. never - Annotation is not automatically exported and must be validated in UI manually.
"never"Typical originating region of documents processed in this queue specified in the locale format. If auto option is chosen, the locale will be detected automatically if the organization group has access to Aurora engine. Otherwise, default option (en_GB) will be used.
The locale field is a hint for the AI Engine on how to resolve some ambiguous cases during data extraction, concerning e.g. date formats or decimal separators that may depend on the locale. For example, in US the typical date format is mm/dd/yyyy whilst in Europe it is dd.mm.yyyy. A date such as "12. 6. 2018" will be extracted as Jun 12 when locale is en_GB, while the same date will be extracted as Dec 6 when locale is en_US.
"en_GB"Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Affects exporting - when true, confirm endpoint transitions annotation to confirmed status instead to exporting.
falseData retention period -- annotations will be automatically purged this time after their creation. The format of the value is '[DD] [HH:[MM:]]ss[.uuuuuu]', e.g. 90 days retention can be set as '90 00:00:00'. Please keep in mind that purging documents in Rossum can limit its learning capabilities. This is a priced feature and has no effect unless enabled.
Default:nullResponse
OK
ID of the queue.
Name of the queue (max. 255 characters).
maxLength: 255URL of the queue.
Workspace in which the queue should be placed (it can be set to null, but bare in mind that it will make the queue invisible in the Rossum UI and it may cause some unexpected consequences).
Connector associated with the queue.
Default:null(Deprecated) Webhooks associated with the queue (serves as an alias for hooks attribute).
[]Hooks associated with the queue.
Default:[]Schema which will be applied to annotations in this queue.
Inbox for import to this queue.
Default:nullUsers associated with this queue.
Default:[]Time before annotation will be returned from reviewing status to to_review (timeout is evaluated every 10 minutes).
"01:00:00"(Deprecated) Use generic_engine or dedicated_engine to set AI Core Engine.
nullURL parameters to be passed to the AI Core Engine. More specific AI Core Engine parameters influencing the extraction may be set using this field.
Publicly available parameters:
effective_page_count(int): Limits the extraction to the firsteffective_page_countpages of the document. Useful to prevent data extraction from additional pages of unrelated, but included documents. Default: 32 (pages to be extracted from a document).tables(boolean): Allows disabling line item data extraction. Useful to speed up data extraction when line item details are not required, especially on long documents with large tables. Default: true (line items are being extracted).
nullDedicated engine used for processing documents uploaded to this queue. If dedicated_engine is set generic_engine must be null. If both engines are null, a default generic one gets set.
nullGeneric engine used for processing documents uploaded to this queue. If generic_engine is set dedicated_engine must be null. If both engines are null, a default generic one gets set.
nullThreshold used to automatically validate field content based on AI confidence scores.
min: 0, max: 1Default:0.8Toggle for switching automation on/off.
Default:falseSet level of automation. always - Auto-export all documents with no validation errors. When there is an error triggered for a non-required field, such values are deleted and export is re-tried. confident - Auto-export documents with at least one validation source and no validation errors. never - Annotation is not automatically exported and must be validated in UI manually.
"never"Typical originating region of documents processed in this queue specified in the locale format. If auto option is chosen, the locale will be detected automatically if the organization group has access to Aurora engine. Otherwise, default option (en_GB) will be used.
The locale field is a hint for the AI Engine on how to resolve some ambiguous cases during data extraction, concerning e.g. date formats or decimal separators that may depend on the locale. For example, in US the typical date format is mm/dd/yyyy whilst in Europe it is dd.mm.yyyy. A date such as "12. 6. 2018" will be extracted as Jun 12 when locale is en_GB, while the same date will be extracted as Dec 6 when locale is en_US.
"en_GB"Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Affects exporting - when true, confirm endpoint transitions annotation to confirmed status instead to exporting.
falseData retention period -- annotations will be automatically purged this time after their creation. The format of the value is '[DD] [HH:[MM:]]ss[.uuuuuu]', e.g. 90 days retention can be set as '90 00:00:00'. Please keep in mind that purging documents in Rossum can limit its learning capabilities. This is a priced feature and has no effect unless enabled.
Default:nullCurrent status of the queue. active - This is the default status. Queue is usable. deletion_requested - Queue is marked for deletion (by calling DELETE /v1/queues/<id>). Will be asynchronously deleted after delete_after. deletion_in_progress - Queue is currently being deleted. When a queue has this status some raise conditions may occur as the related objects are being gradually deleted. deletion_failed - Something wrong happened in the process of queue deletion. The queue may be in an inconsistent state.
Please note, that document import (via upload as well as email) is disabled while the queue status is one of deletion_requested, deletion_in_progress, deletion_failed.
"active"User that last modified the object.
Timestamp of last modification.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Create queue from template
Create new queue object from template organization.
curl -X POST "https://example.rossum.app/api/v1/queues/from_template" \ -H "Content-Type: application/json" \ -d '{ "name": "Invoice Processing - ACME Corp", "template_name": "EU Invoice Template", "workspace": "https://example.rossum.app/api/v1/workspaces/489", "include_documents": true, "engine": "https://example.rossum.app/api/v1/engines/8" }'{
"id": 8198,
"name": "Received invoices",
"url": "https://example.rossum.app/api/v1/queues/8198",
"workspace": "https://example.rossum.app/api/v1/workspaces/7540",
"connector": null,
"webhooks": [],
"hooks": [],
"schema": "https://example.rossum.app/api/v1/schemas/31336",
"inbox": "https://example.rossum.app/api/v1/inboxes/1229",
"users": [
"https://example.rossum.app/api/v1/users/10775"
],
"session_timeout": "01:00:00",
"rir_url": null,
"rir_params": null,
"dedicated_engine": null,
"generic_engine": "https://example.rossum.app/api/v1/generic_engines/3000",
"counts": {
"importing": 0,
"split": 0,
"failed_import": 0,
"to_review": 2,
"reviewing": 0,
"confirmed": 0,
"exporting": 0,
"postponed": 0,
"failed_export": 0,
"exported": 0,
"deleted": 0,
"purged": 0,
"rejected": 0
},
"default_score_threshold": 0.8,
"automation_enabled": false,
"automation_level": "never",
"locale": "en_US",
"metadata": {
"some_key": "some_value"
},
"use_confirmed_state": false,
"document_lifetime": "01:00:00",
"status": "active",
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"settings": {},
"workflows": []
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
Name of a queue.
Template to use for new queue.
ID of a workspace.
Whether to copy documents from the template queue.
Engine to be attached to the queue.
Response
Created
ID of the queue.
Name of the queue (max. 255 characters).
maxLength: 255URL of the queue.
Workspace in which the queue should be placed (it can be set to null, but bare in mind that it will make the queue invisible in the Rossum UI and it may cause some unexpected consequences).
Connector associated with the queue.
Default:null(Deprecated) Webhooks associated with the queue (serves as an alias for hooks attribute).
[]Hooks associated with the queue.
Default:[]Schema which will be applied to annotations in this queue.
Inbox for import to this queue.
Default:nullUsers associated with this queue.
Default:[]Time before annotation will be returned from reviewing status to to_review (timeout is evaluated every 10 minutes).
"01:00:00"(Deprecated) Use generic_engine or dedicated_engine to set AI Core Engine.
nullURL parameters to be passed to the AI Core Engine. More specific AI Core Engine parameters influencing the extraction may be set using this field.
Publicly available parameters:
effective_page_count(int): Limits the extraction to the firsteffective_page_countpages of the document. Useful to prevent data extraction from additional pages of unrelated, but included documents. Default: 32 (pages to be extracted from a document).tables(boolean): Allows disabling line item data extraction. Useful to speed up data extraction when line item details are not required, especially on long documents with large tables. Default: true (line items are being extracted).
nullDedicated engine used for processing documents uploaded to this queue. If dedicated_engine is set generic_engine must be null. If both engines are null, a default generic one gets set.
nullGeneric engine used for processing documents uploaded to this queue. If generic_engine is set dedicated_engine must be null. If both engines are null, a default generic one gets set.
nullThreshold used to automatically validate field content based on AI confidence scores.
min: 0, max: 1Default:0.8Toggle for switching automation on/off.
Default:falseSet level of automation. always - Auto-export all documents with no validation errors. When there is an error triggered for a non-required field, such values are deleted and export is re-tried. confident - Auto-export documents with at least one validation source and no validation errors. never - Annotation is not automatically exported and must be validated in UI manually.
"never"Typical originating region of documents processed in this queue specified in the locale format. If auto option is chosen, the locale will be detected automatically if the organization group has access to Aurora engine. Otherwise, default option (en_GB) will be used.
The locale field is a hint for the AI Engine on how to resolve some ambiguous cases during data extraction, concerning e.g. date formats or decimal separators that may depend on the locale. For example, in US the typical date format is mm/dd/yyyy whilst in Europe it is dd.mm.yyyy. A date such as "12. 6. 2018" will be extracted as Jun 12 when locale is en_GB, while the same date will be extracted as Dec 6 when locale is en_US.
"en_GB"Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Affects exporting - when true, confirm endpoint transitions annotation to confirmed status instead to exporting.
falseData retention period -- annotations will be automatically purged this time after their creation. The format of the value is '[DD] [HH:[MM:]]ss[.uuuuuu]', e.g. 90 days retention can be set as '90 00:00:00'. Please keep in mind that purging documents in Rossum can limit its learning capabilities. This is a priced feature and has no effect unless enabled.
Default:nullCurrent status of the queue. active - This is the default status. Queue is usable. deletion_requested - Queue is marked for deletion (by calling DELETE /v1/queues/<id>). Will be asynchronously deleted after delete_after. deletion_in_progress - Queue is currently being deleted. When a queue has this status some raise conditions may occur as the related objects are being gradually deleted. deletion_failed - Something wrong happened in the process of queue deletion. The queue may be in an inconsistent state.
Please note, that document import (via upload as well as email) is disabled while the queue status is one of deletion_requested, deletion_in_progress, deletion_failed.
"active"User that last modified the object.
Timestamp of last modification.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Duplicate queue
Duplicate a queue object.
curl -X POST "https://example.rossum.app/api/v1/queues/0/duplicate" \ -H "Content-Type: application/json" \ -d '{ "name": "Invoice Processing - ACME Corp (Copy)", "copy_extensions_settings": true, "copy_email_settings": true, "copy_delete_recommendations": true, "copy_automation_settings": true, "copy_permissions": true, "copy_rules_and_actions": true }'{
"id": 8198,
"name": "Received invoices",
"url": "https://example.rossum.app/api/v1/queues/8198",
"workspace": "https://example.rossum.app/api/v1/workspaces/7540",
"connector": null,
"webhooks": [],
"hooks": [],
"schema": "https://example.rossum.app/api/v1/schemas/31336",
"inbox": "https://example.rossum.app/api/v1/inboxes/1229",
"users": [
"https://example.rossum.app/api/v1/users/10775"
],
"session_timeout": "01:00:00",
"rir_url": null,
"rir_params": null,
"dedicated_engine": null,
"generic_engine": "https://example.rossum.app/api/v1/generic_engines/3000",
"counts": {
"importing": 0,
"split": 0,
"failed_import": 0,
"to_review": 2,
"reviewing": 0,
"confirmed": 0,
"exporting": 0,
"postponed": 0,
"failed_export": 0,
"exported": 0,
"deleted": 0,
"purged": 0,
"rejected": 0
},
"default_score_threshold": 0.8,
"automation_enabled": false,
"automation_level": "never",
"locale": "en_US",
"metadata": {
"some_key": "some_value"
},
"use_confirmed_state": false,
"document_lifetime": "01:00:00",
"status": "active",
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"settings": {},
"workflows": []
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
Name of the duplicated queue.
Whether to copy hooks.
Default:trueWhether to copy email notifications settings.
Default:trueWhether to copy delete recommendations.
Default:trueWhether to copy automation level, automation settings and automation_enabled queue settings.
trueWhether to copy users and memberships.
Default:trueWhether to copy rules.
Default:trueResponse
Created
ID of the queue.
Name of the queue (max. 255 characters).
maxLength: 255URL of the queue.
Workspace in which the queue should be placed (it can be set to null, but bare in mind that it will make the queue invisible in the Rossum UI and it may cause some unexpected consequences).
Connector associated with the queue.
Default:null(Deprecated) Webhooks associated with the queue (serves as an alias for hooks attribute).
[]Hooks associated with the queue.
Default:[]Schema which will be applied to annotations in this queue.
Inbox for import to this queue.
Default:nullUsers associated with this queue.
Default:[]Time before annotation will be returned from reviewing status to to_review (timeout is evaluated every 10 minutes).
"01:00:00"(Deprecated) Use generic_engine or dedicated_engine to set AI Core Engine.
nullURL parameters to be passed to the AI Core Engine. More specific AI Core Engine parameters influencing the extraction may be set using this field.
Publicly available parameters:
effective_page_count(int): Limits the extraction to the firsteffective_page_countpages of the document. Useful to prevent data extraction from additional pages of unrelated, but included documents. Default: 32 (pages to be extracted from a document).tables(boolean): Allows disabling line item data extraction. Useful to speed up data extraction when line item details are not required, especially on long documents with large tables. Default: true (line items are being extracted).
nullDedicated engine used for processing documents uploaded to this queue. If dedicated_engine is set generic_engine must be null. If both engines are null, a default generic one gets set.
nullGeneric engine used for processing documents uploaded to this queue. If generic_engine is set dedicated_engine must be null. If both engines are null, a default generic one gets set.
nullThreshold used to automatically validate field content based on AI confidence scores.
min: 0, max: 1Default:0.8Toggle for switching automation on/off.
Default:falseSet level of automation. always - Auto-export all documents with no validation errors. When there is an error triggered for a non-required field, such values are deleted and export is re-tried. confident - Auto-export documents with at least one validation source and no validation errors. never - Annotation is not automatically exported and must be validated in UI manually.
"never"Typical originating region of documents processed in this queue specified in the locale format. If auto option is chosen, the locale will be detected automatically if the organization group has access to Aurora engine. Otherwise, default option (en_GB) will be used.
The locale field is a hint for the AI Engine on how to resolve some ambiguous cases during data extraction, concerning e.g. date formats or decimal separators that may depend on the locale. For example, in US the typical date format is mm/dd/yyyy whilst in Europe it is dd.mm.yyyy. A date such as "12. 6. 2018" will be extracted as Jun 12 when locale is en_GB, while the same date will be extracted as Dec 6 when locale is en_US.
"en_GB"Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Affects exporting - when true, confirm endpoint transitions annotation to confirmed status instead to exporting.
falseData retention period -- annotations will be automatically purged this time after their creation. The format of the value is '[DD] [HH:[MM:]]ss[.uuuuuu]', e.g. 90 days retention can be set as '90 00:00:00'. Please keep in mind that purging documents in Rossum can limit its learning capabilities. This is a priced feature and has no effect unless enabled.
Default:nullCurrent status of the queue. active - This is the default status. Queue is usable. deletion_requested - Queue is marked for deletion (by calling DELETE /v1/queues/<id>). Will be asynchronously deleted after delete_after. deletion_in_progress - Queue is currently being deleted. When a queue has this status some raise conditions may occur as the related objects are being gradually deleted. deletion_failed - Something wrong happened in the process of queue deletion. The queue may be in an inconsistent state.
Please note, that document import (via upload as well as email) is disabled while the queue status is one of deletion_requested, deletion_in_progress, deletion_failed.
"active"User that last modified the object.
Timestamp of last modification.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Export annotations
Export annotations from the queue in XML, CSV, JSON or XLSX format.
Output format is negotiated by Accept header or format parameter. Supported formats are: csv, xml, xlsx and json.
Calling GET will give you results for all the annotations with any of the selected status.
curl -X GET "https://example.rossum.app/api/v1/queues/0/export?id=1%2C2%2C3"{}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
responseobjectInvalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Export annotations (POST)
Export annotations from the queue in XML, CSV, JSON or XLSX format.
Calling POST is useful if you are using confirmed state (queue.use_confirmed_state = true). Without specifying to_status, annotations will stay in their current status. If called on annotations that are already in exporting or exported status, POST call will only download the data, it will not move the annotations to a different state.
curl -X POST "https://example.rossum.app/api/v1/queues/0/export?id=1%2C2%2C3"{}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
responseobjectInvalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Import document (deprecated)
Deprecated: Please note that this upload endpoint is deprecated in favor of create upload endpoint.
Uploads a document to the queue (starting in the importing state). This creates a document object and an empty annotation object.
The file can be sent as a part of multipart/form-data or, alternatively, in the request body. Multiple files upload is supported, the total size of the data uploaded may not exceed 40 MB. UTF-8 filenames are supported.
You can also specify additional properties using form field:
- metadata could be passed using
metadataform field. Metadata will be set to newly created annotation object. - values could be passed using
valuesform field. It may be used to initialize datapoint values by setting the value ofrir_field_namesin the schema.
Upload endpoint also supports basic authentication to enable easy integration with third-party systems.
curl -X POST "https://example.rossum.app/api/v1/queues/0/upload"{
"results": [
{
"annotation": "https://example.rossum.app/api/v1/annotations/315123",
"document": "https://example.rossum.app/api/v1/documents/215789"
}
],
"annotation": "https://example.rossum.app/api/v1/annotations/315123",
"document": "https://example.rossum.app/api/v1/documents/215789"
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Files to upload.
Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Values to initialize datapoint values.
Response
Created
(Obsolete) URL of first created annotation.
(Obsolete) URL of first created document.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Deprecated: Please note that this upload endpoint is deprecated in favor of create upload endpoint.
Uploads a document to the queue with filename specified in URL (starting in the importing state). This creates a document object and an empty annotation object.
UTF-8 filenames must be URL encoded.
Upload endpoint also supports basic authentication to enable easy integration with third-party systems.
curl -X POST "https://example.rossum.app/api/v1/queues/0/upload/string" \ -H "Content-Type: application/octet-stream" \ -d 'string'{
"results": [
{
"annotation": "https://example.rossum.app/api/v1/annotations/315123",
"document": "https://example.rossum.app/api/v1/documents/215789"
}
],
"annotation": "https://example.rossum.app/api/v1/annotations/315123",
"document": "https://example.rossum.app/api/v1/documents/215789"
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/octet-stream
bodystring (binary)Response
Created
(Obsolete) URL of first created annotation.
(Obsolete) URL of first created document.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Retrieve related object counts
This is an internal API method that can change without notice.
Get counts of selected related objects for a queue.
curl -X GET "https://example.rossum.app/api/v1/queues/0/related_objects_counts"{
"emails": 0,
"annotations": 0,
"trained_dedicated_engines": 0
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
Number of email objects related to the queue.
Number of annotation objects related to the queue (purged annotations are excluded from this count).
Number of dedicated engines using the queue for training.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Retrieve suggested email recipients
Retrieves suggested email recipients depending on Queues suggested recipients settings.
curl -X POST "https://example.rossum.app/api/v1/queues/0/suggested_recipients" \ -H "Content-Type: application/json" \ -d '{ "annotations": [ "https://example.rossum.app/api/v1/annotations/315777", "https://example.rossum.app/api/v1/annotations/315778" ], "email_threads": [ "https://example.rossum.app/api/v1/email_threads/7524" ] }'{
"results": [
{
"source": "email_header",
"email": "don.joe@corp.us",
"name": "Don Joe"
}
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
List of annotation urls.
List of email thread urls.
Response
OK
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Start validation
This endpoint is INTERNAL and may change in the future.
Start reviewing the next available annotation from the queue by the calling user.
curl -X POST "https://example.rossum.app/api/v1/queues/0/next" \ -H "Content-Type: application/json" \ -d '{ "annotation_ids": [ 315123, 315124, 315125 ], "statuses": [ "to_review", "reviewing" ] }'{
"annotation": "https://example.rossum.app/api/v1/annotations/315123",
"session_timeout": "01:00:00"
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
List of annotation ids to select from (optional).
List of allowed statuses (optional).
Response
OK
URL of started annotation. If there is no annotation to start, this will be null.
Session timeout in format HH:MM:SS.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error