ROrossum
Queue

Import document with filename (deprecated)

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.

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

Request

Path parameters

idinteger required

Queue ID

filenamestring required

Filename for the uploaded document (UTF-8 filename must be URL encoded)

Request body application/octet-stream

string binary required

Response

Created

annotationstring uri

(Obsolete) URL of first created annotation.

documentstring uri

Document URL.

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 operation across all 14 revisions of this API.