Skip to content
Fylane
Get API key

API reference

View as Markdown

Every endpoint in v1 — 24 operations, rendered from the OpenAPI document rather than described alongside it.

This page is generated from the same OpenAPI document served at /openapi.json. If the two ever disagree, the document is right and this page is a bug.

OperationSummaryTag
POST /v1/uploadsCreate an upload sessionUploads
GET /v1/uploads/{upload_id}Retrieve an upload sessionUploads
POST /v1/uploads/{upload_id}/partsRe-mint part URLsUploads
POST /v1/uploads/{upload_id}/complete-partsAssemble a multipart uploadUploads
POST /v1/uploads/{upload_id}/abortAbort a multipart uploadUploads
GET /v1/jobsList jobsJobs
POST /v1/jobsCreate a jobJobs
GET /v1/jobs/{job_id}Retrieve a jobJobs
POST /v1/batchesCreate a batchJobs
GET /v1/batches/{batch_id}Retrieve a batchJobs
GET /v1/filesList filesFiles
GET /v1/files/{file_id}Retrieve a fileFiles
DELETE /v1/files/{file_id}Delete a fileFiles
POST /v1/files/{file_id}/completeComplete an uploadUploads
GET /v1/files/{file_id}/historyRetrieve a file’s historyFiles
POST /v1/files/{file_id}/download-urlMint a download URLFiles
POST /v1/jobs/{job_id}/cancelCancel a queued jobJobs
GET /v1/limitsSupported formats, operations and ceilingsUsage
POST /v1/estimateEstimate a job before creating itUsage
GET /v1/webhook-endpointsList webhook endpointsWebhooks
POST /v1/webhook-endpointsRegister a webhook endpointWebhooks
DELETE /v1/webhook-endpoints/{webhook_endpoint_id}Delete a webhook endpointWebhooks
POST /v1/webhook-endpoints/{webhook_endpoint_id}/testSend a test eventWebhooks
GET /v1/usageRetrieve usageUsage

Sections

  • Uploads — Getting bytes into Fylane without them touching the API.
  • Jobs — Asking for work and finding out how it went.
  • Files — Stored files and the artifacts derived from them.
  • Webhooks — Signed delivery of events, so you do not have to poll.
  • Usage — Credits, storage and egress for the current period.