Reference
Every public route, with the scope it needs and the bucket it counts against. Paths are relative to the base URL.
Reading this reference
Base URL: https://api.myrlin.io/api/pipeline/v1. Send the key as X-API-Key or Authorization: Bearer. The route list, scopes, buckets and parameters are generated from the API (version 0.3.0). Operator routes that only administrator accounts can use are left out. Responses are plain JSON objects; only GET /me has a typed response model in the API, so the other routes describe their fields in words.
Every route can also answer the authentication, scope and rate limit errors on the errors page.
Account and discovery
| Route | Scope | What it does |
|---|---|---|
| GET/capabilities | none | Read what this server accepts and can return. |
| GET/me | none | Describe the credential you are calling with. |
| GET/pricing | batches:quote | Read the price list, lane availability and your live limits. |
Projects and assets
| Route | Scope | What it does |
|---|---|---|
| GET/projects | projects:read | List your pipeline projects, oldest first. |
| GET/projects/{slug} | projects:read | Read one project. |
| PUT/projects/{slug} | projects:write | Create a project, or update the one with this slug. |
| GET/projects/{slug}/assets | projects:read | List a project's assets with their latest delivered files. |
| GET/projects/{slug}/assets/{assetId} | projects:read | Read one asset by its manifest id. |
| GET/projects/{slug}/assets/{assetId}/history | projects:read | Read every file version and review of one asset. |
| GET/projects/{slug}/progress | projects:read | Read the works-in-progress view of a project. |
| GET/projects/{slug}/quality | projects:read | Read the rejection rate of a project's delivered files. |
| GET/projects/{slug}/receipt | results:read | Read the measured compute and cost totals of a project. |
| GET/projects/{slug}/thumbnails | results:read | Read up to 100 delivered PNG icons in one call. |
Inputs
| Route | Scope | What it does |
|---|---|---|
| POST/projects/{slug}/inputs | inputs:write | Upload an input ZIP: reference art and sources the manifest points at. |
Batches
| Route | Scope | What it does |
|---|---|---|
| GET/batches/{batchId} | batches:read | Read a batch's status. |
| POST/batches/{batchId}/cancel | batches:cancel | Cancel a batch. |
| GET/batches/{batchId}/events | batches:read | Read a batch's event log, oldest first. |
| GET/batches/{batchId}/receipt | results:read | Read the cost receipt of one batch. |
| GET/batches/{batchId}/wait | batches:read | Long poll: return when the batch has a new event, reaches an end state, or the timeout passes. |
| POST/projects/{slug}/batches | batches:submit | Approve a quote and start the batch. |
| POST/projects/{slug}/batches/quote | batches:quote | Plan a batch and price it. Nothing is created or charged. |
| POST/projects/{slug}/lint | batches:quote | Check a manifest and its inputs without a quote. |
| POST/projects/{slug}/resize | batches:quote | Resize assets uniformly: a preview, or a manifest and its 0-credit quote. |
| POST/projects/{slug}/restore | batches:quote | Restore an asset's files to an older version: a manifest and its 0-credit quote. |
Results and files
| Route | Scope | What it does |
|---|---|---|
| GET/batches/{batchId}/preview.png | results:read | Read the contact sheet preview of one output file. |
| GET/batches/{batchId}/result-url | results:read | Get a short-lived link to the result ZIP in storage. |
| GET/batches/{batchId}/result.json | results:read | Read the batch result document. |
| GET/batches/{batchId}/result.zip | results:read | Download the ZIP of delivered files. |
| GET/files/{fileId} | results:read | Read the bytes of one delivered PNG or OGG file you own. |
| GET/files/{fileId}/download | results:read | Download one delivered file you own, any format, up to 256 MB. |
Reviews and evidence
| Route | Scope | What it does |
|---|---|---|
| POST/projects/{slug}/evidence | reviews:write | Upload screenshots and logs to attach to a review. |
| POST/projects/{slug}/reviews | reviews:write | Submit a review of delivered assets. |
Notifications
| Route | Scope | What it does |
|---|---|---|
| GET/notifications | projects:read | List your notices, newest first. |
| GET/notifications/preferences | projects:read | Read your email switches per notice kind. |
| PUT/notifications/preferences | projects:write | Change your email switches. |
| POST/notifications/read-all | projects:write | Mark every notice you can see as read. |
| POST/notifications/{notificationId}/read | projects:write | Mark one notice as read. |