# API reference

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.

| Operation | Summary | Tag |
| --- | --- | --- |
| `POST /v1/uploads` | Create an upload session | Uploads |
| `GET /v1/uploads/{upload_id}` | Retrieve an upload session | Uploads |
| `POST /v1/uploads/{upload_id}/parts` | Re-mint part URLs | Uploads |
| `POST /v1/uploads/{upload_id}/complete-parts` | Assemble a multipart upload | Uploads |
| `POST /v1/uploads/{upload_id}/abort` | Abort a multipart upload | Uploads |
| `GET /v1/jobs` | List jobs | Jobs |
| `POST /v1/jobs` | Create a job | Jobs |
| `GET /v1/jobs/{job_id}` | Retrieve a job | Jobs |
| `POST /v1/batches` | Create a batch | Jobs |
| `GET /v1/batches/{batch_id}` | Retrieve a batch | Jobs |
| `GET /v1/files` | List files | Files |
| `GET /v1/files/{file_id}` | Retrieve a file | Files |
| `DELETE /v1/files/{file_id}` | Delete a file | Files |
| `POST /v1/files/{file_id}/complete` | Complete an upload | Uploads |
| `GET /v1/files/{file_id}/history` | Retrieve a file’s history | Files |
| `POST /v1/files/{file_id}/download-url` | Mint a download URL | Files |
| `POST /v1/jobs/{job_id}/cancel` | Cancel a queued job | Jobs |
| `GET /v1/limits` | Supported formats, operations and ceilings | Usage |
| `POST /v1/estimate` | Estimate a job before creating it | Usage |
| `GET /v1/webhook-endpoints` | List webhook endpoints | Webhooks |
| `POST /v1/webhook-endpoints` | Register a webhook endpoint | Webhooks |
| `DELETE /v1/webhook-endpoints/{webhook_endpoint_id}` | Delete a webhook endpoint | Webhooks |
| `POST /v1/webhook-endpoints/{webhook_endpoint_id}/test` | Send a test event | Webhooks |
| `GET /v1/usage` | Retrieve usage | Usage |

## 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.
