Media

Complete a streaming media upload session

post/media/upload-session/{id}/complete

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/media/upload-session/{id}/complete
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Path parameters

idstring required

Pending media ID

Request body

$schemastring uri

A URL to the JSON Schema for this object.

workspace_idstring required

Workspace ID

Example request

{
  "$schema": "https://example.com/api/v1/schemas/CompleteMediaUploadSessionInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

alt_textstring required

Persisted alt text

analysis_errorstring

Media analysis error

analysis_statusstring required

Media analysis status

asset_kindstring required

Media library role

dedupedboolean required

Whether an existing media attachment was reused

design_document_idstring

Producing OpenPost Image Editor design ID

design_page_idstring

Producing OpenPost Image Editor page ID

idstring required

Media ID

mime_typestring required

MIME type

original_filenamestring required

Persisted original filename

parent_media_idstring

Source media ID

poster_thumbnail_urlstring

Poster thumbnail URL

processing_progressinteger required

Server processing progress from 0 to 100

processing_statusstring required

Media processing status

retention_class'library' | 'temporary' required

Media lifecycle class

sizeinteger required

File size in bytes

sourcestring required

Media provenance

urlstring required

URL to access the media

Example response

{
  "$schema": "https://example.com/api/v1/schemas/MediaUploadResult.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.