Create Asynchronously

post

https://api.lucid.co/v1/documents/import/jobs

Starts an asynchronous import of a document file. This endpoint will immediately reserve a document ID, but the document is not necessarily created nor populated until the job has succeeded.

The uploaded file must not exceed 50 MB.

📘
This is a long-running job request endpoint. See Long-Running Jobs.

Body Params

file

required

The file to import. Maximum size is 50 MB.

type

string

enum

required

MIME type describing the supplied import file.

product

string

enum

Required for Lucid Standard Import files. Selects the product in which to create the document.

Allowed:

title

string

Title for the imported document. Defaults to the file name without its extension.

parent

integer

Folder ID in which to create the imported document. Cannot be provided with team.

team

string

Team ID whose folder should contain the imported document. Cannot be provided with parent.

Headers

Idempotency-Key

string

Distinguishing key for duplicate job requests. Use a different value if intending to run the same job twice.

Responses

400

Bad Request. The request is malformed, does not include exactly one file, or contains invalid import parameters.

403

Forbidden. The caller lacks permission to create the requested document or use the requested destination.

415

Unsupported Media Type. The supplied import type is not supported.

429

Too Many Requests. The account exceeded the import rate limit.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

This is a long-running job request endpoint. See Long-Running Jobs​.

200OK. Returns the queued or existing import job and the ID reserved for the imported document.

This is a long-running job request endpoint. See Long-Running Jobs.