Metadata Generation

When a metadata generation job completes, the platform stores a Metadata record and embeds the same fields on the linked Transcription (generatedMetadata).

Create metadata generation jobs via POST /v1/jobs (serviceType: metadata). Poll the job until status: completed, then fetch or modify the generated metadata with the endpoints below.

Endpoints

The Metadata object

generatedboolean
True when metadata was persisted.
metadataIdstring
Unique metadata record id (mdt_…).
jobIdstring
Parent metadata generation job (job_…).
titlestring
AI-generated or manually updated title.
descriptionstring
Detailed summary.
iabCategoriesarray
Top matched IAB taxonomy categories (strings).
chaptersarray
Timeline chapter markers — each item has startTime (seconds) and title.
generatedAttimestamp
When metadata was generated or last updated.

Retrieve transcript metadata

GET/v1/transcriptions/{transcriptionId}/metadata
Returns the AI-generated or manually updated metadata for a given transcription.

Requires permission

transcript:read

Parameters

transcriptionIdstring
Transcript identifier.

Returns

Returns the Metadata object inside the data envelope.

See the the metadata object for attribute details.

Patch transcript metadata

PATCH/v1/transcriptions/{transcriptionId}/metadata
Partially updates title, description, categories, or chapters.

Requires permission

transcript:edit

Create body example:
{
  "serviceType": "metadata",
  "input": {
    "textSourceId": "txt_01HX2K9V3JEK4WYZN6F0XQ2W8M"
  },
  "userMetadata": {
    "customerJobRef": "metadata-01HX2K9V3JEK4WYZ"
  }
}

Parameters

transcriptionIdstring
Transcript identifier.

Returns

Returns the fully updated Metadata object.

See the the metadata object for attribute details.