Sign in
Queue

Retrieve queue

Get a queue object.

get/api/v1/queues/{id}

Path parameters

idinteger required

Queue ID

Response

OK

idinteger required

ID of the queue.

namestring required

Name of the queue (max. 255 characters).

urlstring uri required

URL of the queue.

workspacestring uri nullable required

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).

connectorstring uri nullable required

Connector associated with the queue.

webhooksstring[] required

(Deprecated) Webhooks associated with the queue (serves as an alias for hooks attribute).

hooksstring[] required

Hooks associated with the queue.

schemastring uri required

Schema which will be applied to annotations in this queue.

inboxstring uri nullable required

Inbox for import to this queue.

usersstring[] required

Users associated with this queue.

session_timeoutstring required

Time before annotation will be returned from reviewing status to to_review (timeout is evaluated every 10 minutes).

rir_urlstring uri nullable required

(Deprecated) Use generic_engine or dedicated_engine to set AI Core Engine.

<Callout type="warn"> Since April 5, 2022, `rir_url` and `agenda` in `rir_params` is no longer used to set AI Engine to the Queue. To change engine use attributes `generic_engine` and `dedicated_engine`. Queues created with parameter `rir_url` will have corresponding `generic_engine` or `dedicated_engine` set automatically. </Callout>
rir_paramsstring nullable required

URL 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 first effective_page_count pages 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).
dedicated_enginestring uri nullable required

Dedicated 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.

generic_enginestring uri nullable required

Generic 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.

default_score_thresholdnumber float required

Threshold used to automatically validate field content based on AI confidence scores.

<Callout type="warn"> The old behavior enabled `default_score_threshold` set to null on queue. When threshold on queue was set to null then default value 0.975 was used. Starting from February 24, 2020 setting of default_score_threshold to null is deprecated. Due to backward compatibility if null value is passed then default value 0.8 is set to `default_score_threshold`. </Callout>
automation_enabledboolean required

Toggle for switching automation on/off.

automation_level'never' | 'confident' | 'always' required

Set 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.

localestring required

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.

metadataMetadata required

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

use_confirmed_stateboolean required

Affects exporting - when true, confirm endpoint transitions annotation to confirmed status instead to exporting.

document_lifetimestring nullable required

Data 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.

status'active' | 'deletion_requested' | 'deletion_in_progress' | 'deletion_failed' required

Current 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.

modified_bystring uri nullable required

User that last modified the object.

modified_atstring date-time nullable required

Timestamp of last modification.

Example response

{
  "id": 8198,
  "name": "Received invoices",
  "url": "https://example.rossum.app/api/v1/queues/8198",
  "workspace": "https://example.rossum.app/api/v1/workspaces/7540",
  "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",
  "generic_engine": "https://example.rossum.app/api/v1/generic_engines/3000",
  "counts": {
    "to_review": 2
  },
  "default_score_threshold": 0.8,
  "automation_level": "never",
  "locale": "en_US",
  "metadata": {
    "some_key": "some_value"
  },
  "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": {
    "hide_export_button": true,
    "accepted_mime_types": [],
    "automation": {
      "automate_duplicates": true
    },
    "rejection_config": {
      "enabled": true
    },
    "suggested_recipients_sources": [
      {
        "source": "email_header"
      }
    ],
    "suggested_edit": "disable",
    "dashboard_customization": {
      "confirmed": true,
      "deleted": true,
      "exported": true,
      "postponed": true,
      "rejected": true,
      "to_review": true
    },
    "email_notifications": {
      "recipient": {
        "email": "john.doe@company.com",
        "name": "John Doe"
      },
      "email_with_no_attachments": true
    },
    "html_conversion_enabled": true,
    "txt_conversion_enabled": true,
    "ui_upload_enabled": true,
    "ui_on_edit_confirm": "validate_first",
    "ui_validation_screen_enabled": true,
    "ui_edit_target_queue_selection_enabled": true,
    "ui_edit_always_split_document": true
  },
  "workflows": [
    {
      "url": "https://example.rossum.app/api/v1/workflows/7540",
      "priority": 2
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.