Skip to main content

ContentDetail

The single-content view. Richer than a list item, and not the same shape: it adds the script and settings, and it does not carry published_url, published_platform or last_error — those appear only on GET /contents.

idstring<uuid>
titlestring
descriptionstring | nullnullable
textoverstring | nullnullable

The on-screen script. Not present on list items.

full_textstring | nullnullable

The source text the script was generated from.

statusContentStatus

Lifecycle of a content item.

Terminal states are UPLOADED and the four FAILED_* values; everything else means work is still in flight.

READY_FOR_UPLOAD is deprecated — it was split into UPLOADING (dispatched) and VIDEO_PROCESSED (rendered but parked with no accounts selected), and only appears on rows written before that change.

Possible values: [NEW, PROCESSING, PROCESSING_AUDIO, AUDIO_PROCESSED, PROCESSING_VIDEO, VIDEO_PROCESSED, UPLOADING, READY_FOR_UPLOAD, UPLOADED, FAILED_AUDIO, FAILED_VIDEO, FAILED_UPLOAD, FAILED]

upload_date(string | null)<date-time>nullable
creation_datestring<date-time>
updated_atstring<date-time>
hashtagsstring | nullnullable
fine_tuningobject | nullnullable
persona object

Expanded here, unlike the list view's {id, name}.

idstring | nullnullable
namestring | nullnullable
has_paceboolean
audio_model_classstring | nullnullable
audio_model_namestring | nullnullable
accounts object[]

Accounts attached to this content.

  • Array [
  • idstring
    namestring
    platformPlatformType

    Exact casing matters. These values are compared literally, so youtube will not match.

    Possible values: [YouTube, TikTok, Instagram]

    platform_acronymstring
  • ]
  • video_urlstring | nullnullable

    Signed and time-limited. Null until rendered.

    thumbnail_urlstring | nullnullable

    Signed and time-limited.

    statsobject | nullnullable
    metadataobject | nullnullable

    Carries last_error on failure.

    progressobject | nullnullable

    Last progress snapshot the worker reported (percentage, step, message). Null when no run is in flight.

    video_settings object

    The render options used on the previous run, so a client can restore them instead of resetting to defaults.

    orientationstring | nullnullable
    prefer_real_worldboolean | nullnullable
    image_overlay_enabledboolean | nullnullable
    image_overlay_positionstring | nullnullable
    zoom_effect_enabledboolean | nullnullable
    subtitle_settingsobject | nullnullable
    ContentDetail
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "string",
    "description": "string",
    "textover": "string",
    "full_text": "string",
    "status": "NEW",
    "upload_date": "2024-07-29T15:51:28.071Z",
    "creation_date": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "hashtags": "string",
    "fine_tuning": "Unknown Type: object,null",
    "persona": {
    "id": "string",
    "name": "string",
    "has_pace": true,
    "audio_model_class": "string",
    "audio_model_name": "string"
    },
    "accounts": [
    {
    "id": "string",
    "name": "string",
    "platform": "YouTube",
    "platform_acronym": "string"
    }
    ],
    "video_url": "string",
    "thumbnail_url": "string",
    "stats": "Unknown Type: object,null",
    "metadata": "Unknown Type: object,null",
    "progress": "Unknown Type: object,null",
    "video_settings": {
    "orientation": "string",
    "prefer_real_world": true,
    "image_overlay_enabled": true,
    "image_overlay_position": "string",
    "zoom_effect_enabled": true,
    "subtitle_settings": "Unknown Type: object,null"
    }
    }