Sign in
Queue

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 metadata form field. Metadata will be set to newly created annotation object.
  • values could be passed using values form field. It may be used to initialize datapoint values by setting the value of rir_field_names in the schema.

Upload endpoint also supports basic authentication to enable easy integration with third-party systems.

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

Path parameters

idinteger required

Queue ID

Response

Created

annotationstring uri

(Obsolete) URL of first created annotation.

documentstring uri

(Obsolete) URL of first created document.

Example response

{
  "results": [
    {
      "document": "https://example.rossum.app/api/v1/documents/456700"
    }
  ],
  "document": "https://example.rossum.app/api/v1/documents/456700"
}

Changes

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