Audio Recaps

Retrieve audio recap generation status

GET · Audio Recaps

Returns script-generation status for the recap and audio-generation status for each section. Accepts the public component id or the component Mongo _id. recap is null until generation has created the recap row.

OpenAPI specification

GET/api/v1/audio-recaps/components/{componentId}

Authentication

x-api-key

Request

curl --globoff --request GET \
  --url 'https://api.example.com/api/v1/audio-recaps/components/%3CcomponentId%3E' \
  --header 'x-api-key: <API_KEY>'

Replace credential and <field> placeholders with your own values. URL placeholders appear as %3Cfield%3E. Review the example values before sending your request.

Replace https://api.example.com with the API server URL.

Parameters

componentIdpath · string · required

Public component id (audio_recap_…) or the component Mongo _id

Responses

200

{
  "type": "object",
  "properties": {
    "recap": {
      "nullable": true,
      "description": "Null until the recap row exists. Poll until it is present.",
      "allOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "title": {
              "type": "string"
            },
            "generationCompleted": {
              "type": "boolean",
              "description": "True once section scripts have been written."
            },
            "generationStatus": {
              "type": "string",
              "enum": [
                "pending",
                "completed",
                "failed"
              ],
              "description": "Script generation for the recap. pending, completed, or failed."
            },
            "generationError": {
              "type": "string",
              "description": "Present when generationStatus is failed."
            }
          },
          "required": [
            "id",
            "title",
            "generationCompleted",
            "generationStatus"
          ]
        }
      ]
    },
    "sections": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "order": {
            "type": "number"
          },
          "generated": {
            "type": "boolean",
            "description": "Audio for this section is ready."
          },
          "generating": {
            "type": "boolean",
            "description": "Text-to-speech for this section is in progress."
          },
          "errorMsg": {
            "type": "string",
            "description": "Set when audio generation failed for this section."
          }
        },
        "required": [
          "id",
          "order",
          "generated",
          "generating"
        ]
      }
    }
  },
  "required": [
    "recap",
    "sections"
  ]
}

404Audio recap component not found in this organization