Skip to main content
curl https://ytrss.xyz/v1/jobs/batch/<batchId> \
  -H "Authorization: Bearer YOUR_API_KEY"

{
    "batch": {
        "batch_id": "batch_xyz789",
        "jobs": [
            {
                "id": "job_abc123",
                "status": "SUCCESS",
                "youtube_url": "https://youtube.com/watch?v=dQw4w9WgXcQ",
                "download_endpoint": "https://ytrss.xyz/v1/download/job_abc123",
                "video_metadata": {
                    "title": "Never Gonna Give You Up",
                    "duration": 213,
                    "video_id": "dQw4w9WgXcQ",
                    "size": 3456789",
                    "description": "The official video for Rick Astley's 1987 hit..."
                }
            },
            {
                "id": "job_def456",
                "status": "STARTED",
                "url": "https://youtube.com/watch?v=9bZkp7q19f0"
            },
            {
                "id": "job_ghi789",
                "status": "CREATED",
                "url": "https://youtube.com/watch?v=kJQP7kiw5Fk"
            }
        ],
        "counts": {
            "pending": 1,
            "processing": 1,
            "success": 1,
            "error": 0
        },
        "finished": false
    }
}

​
Overview

Retrieve the current status, progress, and details of all jobs in a specific batch. Use this endpoint to monitor multiple conversion jobs that were submitted together.

​
Path Parameters

​
batch_id
string
required
The unique identifier of the batch to retrieve

​
Response

​
batch_id
string
Unique identifier for the batch
​
finished
boolean
Have all the jobs completed
​
jobs
object[]
Array of job objects representing each conversion task
​
counts
object
curl https://ytrss.xyz/v1/jobs/batch/<batchId> \
  -H "Authorization: Bearer YOUR_API_KEY"

{
    "batch": {
        "batch_id": "batch_xyz789",
        "jobs": [
            {
                "id": "job_abc123",
                "status": "SUCCESS",
                "youtube_url": "https://youtube.com/watch?v=dQw4w9WgXcQ",
                "download_endpoint": "https://ytrss.xyz/v1/download/job_abc123",
                "video_metadata": {
                    "title": "Never Gonna Give You Up",
                    "duration": 213,
                    "video_id": "dQw4w9WgXcQ",
                    "size": 3456789",
                    "description": "The official video for Rick Astley's 1987 hit..."
                }
            },
            {
                "id": "job_def456",
                "status": "STARTED",
                "url": "https://youtube.com/watch?v=9bZkp7q19f0"
            },
            {
                "id": "job_ghi789",
                "status": "CREATED",
                "url": "https://youtube.com/watch?v=kJQP7kiw5Fk"
            }
        ],
        "counts": {
            "pending": 1,
            "processing": 1,
            "success": 1,
            "error": 0
        },
        "finished": false
    }
}