Materials

Get debug information for a material including extracted content

GET · Materials

GET/api/v1/materials/{id}/debug

Authentication

x-api-key

Request

curl --globoff --request GET \
  --url 'https://api.example.com/api/v1/materials/%3Cid%3E/debug' \
  --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

idpath · string · required

Material ID

Responses

200Debug content retrieved successfully

{
  "type": "object",
  "properties": {
    "materialId": {
      "type": "string",
      "description": "Material ID"
    },
    "name": {
      "type": "string",
      "description": "Material name"
    },
    "contentType": {
      "type": "string",
      "description": "Content type"
    },
    "status": {
      "type": "string",
      "description": "Processing status"
    },
    "content": {
      "type": "object",
      "description": "Content details"
    },
    "images": {
      "type": "array",
      "description": "Processed images",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "s3Key": {
            "type": "string"
          },
          "s3Url": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "pageIndex": {
            "type": "number"
          }
        }
      }
    },
    "metadata": {
      "type": "object",
      "description": "Material metadata"
    },
    "transcriptStructure": {
      "type": "object",
      "description": "Transcript structure for videos",
      "nullable": true
    }
  },
  "required": [
    "materialId",
    "name",
    "contentType",
    "status",
    "content",
    "images",
    "metadata",
    "transcriptStructure"
  ]
}

404Material not found