Developers
API reference
Every path is under https://impartire.com/api/v1. Generated from the API’s own contract, openapi.json (OpenAPI 3.1), which you can load into any OpenAPI tool. Errors are Problems — see Conventions.
The contract
- GET/api/v1/openapi.jsonThis document
Who is calling
- GET/api/v1/meWho is calling: the key, its org, its scopes and its request budget
Asset types
- GET/api/v1/asset-typesList the asset types the org can create assets of, with their field definitions and file slots
Projects
- GET/api/v1/projectsList the org's projects
- POST/api/v1/projectsCreate a project, optionally typed and under a parent
- GET/api/v1/projects/{id}Get one project
- PATCH/api/v1/projects/{id}Rename, describe or retype a project
- POST/api/v1/projects/{id}/accessGive a member, team or role access to a project (guarded)
- DELETE/api/v1/projects/{id}/accessTake one access grant on a project away (guarded)
- POST/api/v1/projects/{id}/denyDeny a member, team or role on a project (guarded)
- DELETE/api/v1/projects/{id}/denyLift a deny on a project (guarded)
- POST/api/v1/projects/{id}/teamsAssign a team to a production (guarded)
- POST/api/v1/projects/{id}/moveMove a project under another, or to the top level (guarded)
- GET/api/v1/projects/{id}/tagsList the tags on a project
- POST/api/v1/projects/{id}/tagsAdd tags to a project
- DELETE/api/v1/projects/{id}/tags/{tag_id}Remove a tag from a project
Uploads
- POST/api/v1/uploadsPresign a single PUT, or start a multipart upload, for a file (step 1 of creating an asset with a file)
- GET/api/v1/uploads/{id}Get an upload's status: pending, landed, consumed or expired
- POST/api/v1/uploads/{id}/partsSign upload URLs for parts of a multipart upload
- POST/api/v1/uploads/{id}/completeComplete a multipart upload from its parts
- POST/api/v1/uploads/{id}/abortAbort a multipart upload in progress
Assets
- GET/api/v1/assetsList and search the org's assets
- POST/api/v1/assetsCreate an asset in a project, optionally from a landed upload
- GET/api/v1/assets/{id}Get an asset with its current files and recent runs
- PATCH/api/v1/assets/{id}Update an asset's name, fields, project or external_ref
- DELETE/api/v1/assets/{id}Delete an asset (every version)
- GET/api/v1/assets/{id}/referenced-byList the records that reference an asset
- GET/api/v1/assets/{id}/lineageGet an asset's derivation lineage
- GET/api/v1/assets/{id}/playbackGet an asset's playback descriptor
- GET/api/v1/assets/{id}/creditsList the people credited on an asset
- GET/api/v1/assets/{id}/categoriesList an asset's categories
Asset files
- GET/api/v1/assets/{id}/filesList an asset's current files with their technical metadata
- POST/api/v1/assets/{id}/filesAttach an uploaded file to an asset, or replace one of its files with a new version
- GET/api/v1/assets/{id}/files/{file_id}Get one file of an asset, any version, with its version chain
- POST/api/v1/assets/{id}/files/{file_id}/restoreMake an earlier version of a file current again
- GET/api/v1/assets/{id}/files/{file_id}/downloadGet a short-lived URL for one of an asset's files, any version
Asset comments and markers
- GET/api/v1/assets/{id}/commentsList an asset's review comments
- POST/api/v1/assets/{id}/commentsComment on an asset, or reply to a comment
- PATCH/api/v1/assets/{id}/comments/{comment_id}Resolve or reopen a comment, or change its text
- DELETE/api/v1/assets/{id}/comments/{comment_id}Delete a comment
- GET/api/v1/assets/{id}/markersList an asset's clip markers
- POST/api/v1/assets/{id}/markersMark a time range on an asset
- DELETE/api/v1/assets/{id}/markers/{marker_id}Delete a clip marker
Asset share links
- GET/api/v1/assets/{id}/share-linksList an asset's public share links
- POST/api/v1/assets/{id}/share-linksMake a public share link to an asset (guarded)
- DELETE/api/v1/assets/{id}/share-links/{link_id}Revoke a public share link (guarded)
Asset tags
- GET/api/v1/assets/{id}/tagsList the tags on an asset
- POST/api/v1/assets/{id}/tagsAdd tags to an asset
- DELETE/api/v1/assets/{id}/tags/{tag_id}Remove a tag from an asset
Workflows
- GET/api/v1/workflowsList the workflow templates a run can be started from
- GET/api/v1/workflows/{id}Get one workflow template
Runs
- GET/api/v1/runsList workflow runs, most recently changed first
- POST/api/v1/runsStart a workflow run on an asset
- GET/api/v1/runs/{id}Get one workflow run: its status, current step and steps
- POST/api/v1/runs/{id}/signalsApprove, reject, complete or skip a run's step, or cancel the run (guarded)
Tags
- GET/api/v1/tagsList the org's tags
Collections
- GET/api/v1/collectionsList the org's collections
- POST/api/v1/collectionsCreate a collection, filed in a project and optionally nested in another
- GET/api/v1/collections/{id}Get one collection
- PATCH/api/v1/collections/{id}Rename or describe a collection, or change its constraints
- DELETE/api/v1/collections/{id}Delete a collection
- GET/api/v1/collections/{id}/childrenList the collections nested in a collection
- GET/api/v1/collections/{id}/itemsList a collection's items in order
- POST/api/v1/collections/{id}/itemsAdd an asset to a collection
- DELETE/api/v1/collections/{id}/items/{item_id}Remove an item from a collection
- PUT/api/v1/collections/{id}/items/orderPut a collection's items in a new order
Playlists
- GET/api/v1/playlistsList a project's playlists
- POST/api/v1/playlistsCreate a playlist in a project
- GET/api/v1/playlists/{id}Get one playlist
- PATCH/api/v1/playlists/{id}Rename or describe a playlist, or change its target count
- DELETE/api/v1/playlists/{id}Delete a playlist
- GET/api/v1/playlists/{id}/itemsList a playlist's items in order
- POST/api/v1/playlists/{id}/itemsAppend an asset to a playlist
- DELETE/api/v1/playlists/{id}/items/{item_id}Remove an item from a playlist
- PUT/api/v1/playlists/{id}/items/orderPut a playlist's items in a new order
Record types
- GET/api/v1/record-typesList the org's record types and their fields
Records
- GET/api/v1/recordsList one record type's records
- POST/api/v1/recordsCreate a record
- GET/api/v1/records/{id}Get one record
- PATCH/api/v1/records/{id}Retitle a record or replace its fields
- DELETE/api/v1/records/{id}Delete a record
People and credits
- GET/api/v1/peopleList the org's people
- GET/api/v1/people/{id}Get a person
- GET/api/v1/people/{id}/creditsList a person's credits
Categories
- GET/api/v1/categoriesList the org's asset categories
Audit log
- GET/api/v1/audit-logList the org's audit trail
- GET/api/v1/audit-log/{id}Get one audit entry
Delivery requirements and readiness
- GET/api/v1/delivery-requirementsList the org's delivery requirements
- GET/api/v1/delivery-requirements/{id}Get one delivery requirement
- GET/api/v1/delivery-requirements/{id}/readinessRead a requirement's readiness
- GET/api/v1/delivery-requirements/{id}/receiptsList a requirement's receipts
- POST/api/v1/delivery-requirements/{id}/deliverDeliver an asset against a requirement (guarded)
Delivery receipts
- GET/api/v1/delivery-receiptsList the org's delivery receipts
- GET/api/v1/delivery-receipts/{id}Get one delivery receipt
- POST/api/v1/delivery-receipts/{id}/rejectReject a delivery made to the org (guarded)
Inbound deliveries
- GET/api/v1/inbound-deliveriesList deliveries made to the org
Spec profiles
- GET/api/v1/spec-profilesList the spec profiles the org may read
- GET/api/v1/spec-profiles/{id}Get one spec profile
Delivery targets
- GET/api/v1/delivery-targetsList the org's delivery targets
EPG services
- GET/api/v1/servicesList the org's broadcast services
- GET/api/v1/services/{id}Get one broadcast service
EPG schedules
- GET/api/v1/schedulesList a service's schedule in a window
- POST/api/v1/schedulesPut a programme on a service's schedule (guarded)
- GET/api/v1/schedules/{id}Get one schedule slot
- PATCH/api/v1/schedules/{id}Move or change a schedule slot (guarded)
- DELETE/api/v1/schedules/{id}Remove a schedule slot (guarded)
Transmission log
- GET/api/v1/transmission-logRead a service's planned transmission log
EPG formats
- GET/api/v1/formatsList the org's broadcast formats
- GET/api/v1/formats/{id}Get one broadcast format
Analytics
- GET/api/v1/analytics/summaryRead consumption analytics over a range
- GET/api/v1/analytics/operationsRead operations analytics over a range
- GET/api/v1/analytics/searchRead search analytics over a range
Members
- GET/api/v1/membersList the org's members
Playout channels
- GET/api/v1/channelsList the org's playout channels
- GET/api/v1/channels/{id}Get one playout channel
- POST/api/v1/channels/{id}/startStart a playout channel (guarded)
- POST/api/v1/channels/{id}/stopStop a playout channel (guarded)
Confirmations
- GET/api/v1/confirmations/{id}Read a guarded action's confirmation