v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
productions

Register Media

Registers a media file with an order, either by uploading it directly or by providing a URL to fetch it from. Exactly one of media or media_url must be provided. The registered media can then be referenced when adding order items.

post/v1/productions/orders/{order_id}/media

Path parameters

order_idstring required

The ID of the order to which this media will be attached.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

media_idstring required

Example response

{
  "media_id": "prodmedia_01jgb2zd68f8f9tfvbb968wb8z"
}