Skip to content
StudyFetch API

Video Generator

Get video generation status

Check the current status and progress of a video generation job. Returns: - Current status (pending, script_generation, frame_generation, etc.) - Progress percentage (0-100) - Estimated time remaining (if available) - Final result (when completed) - Error message (if failed)

OpenAPI specification
GET/api/v1/video-generator/status/{runId}

Authentication

x-api-key

Request

curl --globoff --request GET \
  --url 'https://api.example.com/api/v1/video-generator/status/%3CrunId%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

runIdpath · string · required

Video generation run ID

Responses

200Status retrieved successfully
{
  "type": "object",
  "properties": {
    "runId": {
      "type": "string",
      "example": "2025-11-15T12-30-45-abc123"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "script_generation",
        "frame_generation",
        "video_prompt_generation",
        "video_generation",
        "video_stitching",
        "completed",
        "failed"
      ],
      "example": "video_generation"
    },
    "progress": {
      "type": "object",
      "properties": {
        "current": {
          "type": "number",
          "example": 3
        },
        "total": {
          "type": "number",
          "example": 5
        },
        "percentage": {
          "type": "number",
          "example": 60
        }
      }
    },
    "result": {
      "type": "object",
      "nullable": true,
      "description": "Available when status is \"completed\""
    },
    "error": {
      "type": "string",
      "nullable": true,
      "description": "Error message if status is \"failed\""
    },
    "estimatedTimeRemaining": {
      "type": "number",
      "nullable": true,
      "description": "Estimated milliseconds until completion"
    }
  }
}
404Video generation not found