Quickstart

📘

Questions?

Please feel free to contact us with any questions or special requirements. We're happy to help.

1. Authenticate

• Obtain an access token from the POST /token endpoint.

2. Register webhooks (optional but recommended)

• Use the POST /webhooks endpoint to start receiving event notifications.

3. Upload a file

• Initialize the upload via POST /files.
• Upload the file content to the provided upload_url with required headers.

4. Validate the file

• Wait for the file.validation.completed webhook event, or
• Poll the file status with GET /files/{file_id}.
• The file must have a valid status before it can be used as job input.

5. Create a job

• Submit a processing job with POST /jobs, referencing the uploaded file as job input.

6. Monitor job progress

• Wait for the job.completed webhook event, or
• Poll the job status with GET /jobs/{job_id}.
• The job must have a completed status for the job output to be available.

7. Retrieve the results

• Download output files via GET /files/{file_id}.
• Retrieve output streams via GET /streams/{stream_id}.