Skip to content
Fylane
Get API key

Documentation

View as Markdown

How Fylane works, what it returns, and what to do when it returns an error. Every page here also exists as Markdown — append `.md` to any URL.

Every page has a Markdown twin
Append .md to any documentation URL for the same content as CommonMark. Both are rendered from one source, so they cannot disagree. The machine-readable contract is at /openapi.json.

Start here

  • QuickstartUpload a file, ask for an operation, receive the result. Three calls, none of which block on the work.
  • ConceptsFiles, jobs, artifacts and credits — the four nouns the whole API is built from, and how they relate.

Reference

  • API referenceEvery endpoint, generated from the OpenAPI document.
  • UploadsGetting bytes into Fylane without them touching the API.
  • JobsAsking for work and finding out how it went.
  • FilesStored files and the artifacts derived from them.
  • WebhooksSigned delivery of events, so you do not have to poll.
  • UsageCredits, storage and egress for the current period.
  • ErrorsEvery code the API can return, and whether retrying helps.