Task Status Management

Monitor and track the progress of your clip generation tasks in real-time.

The Task Status API provides comprehensive tracking of video processing jobs. Each generation task progresses through multiple states and can be monitored through our status endpoints.

Task Lifecycle

Status States

queued

Initial state when task is created

processing

AI model is analyzing video

Learning

AI is learning from the video content

Preparing

Preparing final clip generation

Completed

Task finished successfully

Get Generation Results

GEThttps://api.joinoverlap.com/get-generation-results/{taskId}

Overview

Returns the current status of a generation task. If the task is completed, it includes the generated clips array.

Authentication

bash

Authorization: Bearer YOUR_API_KEY

Response Format (In Progress)

json

{
  "taskId": "task_xyzabc123",
  "status": "processing",
  "startedAt": "2024-12-30T10:15:30Z",
  "estimatedCompletionTime": "2024-12-30T10:25:30Z"
}

Response Format (Completed)

json

{
  "taskId": "task_xyzabc123",
  "status": "Completed",
  "startedAt": "2024-12-30T10:15:30Z",
  "completedAt": "2024-12-30T10:25:30Z",
  "clips": [
    {
      "startTimestamp": "number",
      "endTimestamp": "number", 
      "duration": "number",
      "title": "string",
      "bio": "string",
      "keywords": [
        "string"
      ],
      "people": [
        "string"  
      ],
      "thumbnailURL": "string",
      "url": "string"
    },
    // ... more clips
  ]
}

Example Request

bash

curl https://api.joinoverlap.com/get-generation-results/task_123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Best Practices

Checking Generation Status

Monitor your generation task by checking the status periodically. Once the status shows “Completed”, the response will include the generated clips array. We recommend implementing appropriate retry logic and error handling in your integration.

Get Successful Generations

GEThttps://api.joinoverlap.com/get-successful-generations

Overview

Returns a list of your recent successful clip generation tasks, limited to the last 15 tasks.

Response Format

json

{
  "generations": [
    {
      "taskId": "task_abc123",
      "url": "https://youtube.com/watch?v=...",
      "completedAt": "2024-12-30T10:15:30Z",
      "clipCount": 8
    }
  ]
}

Example Request

bash

curl https://api.joinoverlap.com/get-successful-generations \
  -H "Authorization: Bearer YOUR_API_KEY"