Sign in
Upload

Create upload with filename

Uploads a document to the queue specified as query parameter with filename specified in the URL path. UTF-8 filenames are supported and must be URL encoded.

The file should be sent in the request body. The total size of the data uploaded may not exceed 40 MB.

The endpoint is asynchronous and response contains created task url. Further information about the import status may be acquired by retrieving the upload object or the task (for more information, please refer to task).

post/api/v1/uploads/{filename}

Path parameters

filenamestring required

The filename for the uploaded document. UTF-8 filenames must be URL encoded.

Query parameters

queueinteger required

ID of the target queue for the upload.

reject_identicalboolean

When enabled, upload checks for identical documents within a given organization. If such document is found, upload fails with status 409. The check is performed based on file name and file content. Only one file is allowed when reject_identical is set to true.

Response

Accepted

urlstring url

URL of the created task for tracking upload progress.

Example response

{
  "url": "https://example.rossum.app/api/v1/tasks/315509"
}

Changes

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