Developers

REST API

A versioned HTTPS API for software a production company already uses: read its jobs, shoot days and deliverables, and write cuts, review notes and links to footage back, without anyone copying between tools.

Basics

  • Base URL: https://production-engine.com/api/v1
  • Every request sends a workspace API token that holds scopes, as Authorization: Bearer. See Tokens and scopes.
  • JSON in and out. Keys are snake_case. Enum values are the stored values, never display labels.
  • Lists page with a cursor. See Pagination and filters.
  • Every error has one shape. See REST errors.
  • The token decides the workspace. Another workspace's ids, and deleted records, answer 404.
  • Writes create and update projects and deliverables, add link versions and review notes, and link a job to its assets in your system. They run the same code as the app, and each is logged in the project's activity under the token's name.
  • A POST can carry an Idempotency-Key, so a retry never writes twice. See Retries and idempotency.
  • Money, crew start paperwork and crew contact details are never returned or written.
  • An OpenAPI 3.1 description is public at https://production-engine.com/api/v1/openapi.json.

Your first call

Check the token and read the workspace's time zone:

Request
curl https://production-engine.com/api/v1/me \
  -H "Authorization: Bearer $PE_TOKEN"
Response
{
  "workspace": {
    "id": "cmexampletenant001",
    "name": "Eastside Pictures",
    "time_zone": "America/Los_Angeles"
  },
  "token": {
    "id": "cmexampletoken0001",
    "name": "Shade sync",
    "scopes": [
      "projects:read",
      "schedule:read",
      "deliverables:read"
    ],
    "expires_at": "2027-09-29T00:00:00.000Z"
  }
}

Resources

ResourceEndpoints
WorkspaceGET /me
Projects and linksGET /projects, GET /projects/{id}, GET /projects/{id}/links, POST /projects, PATCH /projects/{id}, POST /projects/{id}/links, PATCH /links/{id}, DELETE /links/{id}
Shoot daysGET /projects/{id}/shoot-days, GET /shoot-days/{id}
Deliverables, versions and review notesGET /projects/{id}/deliverables, GET /deliverables/{id}, GET /deliverables/{id}/versions, POST /projects/{id}/deliverables, PATCH /deliverables/{id}, POST /deliverables/{id}/versions, GET /versions/{id}/notes, POST /versions/{id}/notes
Clients and contactsGET /clients, GET /clients/{id}, GET /contacts, GET /contacts/{id}
LocationsGET /projects/{id}/locations
CrewGET /projects/{id}/crew
Media drivesGET /projects/{id}/media-drives
Webhook endpointsGET /webhook-endpoints, POST /webhook-endpoints, GET /webhook-endpoints/{id}, PATCH /webhook-endpoints/{id}, DELETE /webhook-endpoints/{id}, POST /webhook-endpoints/{id}/test

REST documentation