Jobs API

API Key

The Jobs API allows you to create, retrieve, and manage processing jobs. Jobs represent tasks that process media files (audio, video) and convert them into structured documents. You can use API key authentication to access these endpoints.

API Endpoints

Create Job

POST /jobs

Create a new processing job.

Request (API Key)
Response

curl -X POST https://api.shrinked.com/jobs \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "jobName": "Example Job",
    "scenario": "SINGLE_FILE_DEFAULT",
    "email": "[email protected]",
    "lang": "en",
    "isPublic": true,
    "createPage": false,
    "link": "https://example.com/media/file.mp4"
  }'

{
  "id": "job123456",
  "status": "created",
  "message": "Job created successfully"
}

Get Job by ID

GET /jobs/ID

Retrieve a specific job by its ID.

Request (API Key)
Response

curl -X GET https://api.shrinked.com/jobs/job123456 \
  -H "x-api-key: YOUR_API_KEY"

{
  "id": "job123456",
  "jobName": "Example Job",
  "scenario": "SINGLE_FILE_DEFAULT",
  "email": "[email protected]",
  "lang": "en",
  "isPublic": true,
  "createPage": false,
  "link": "https://example.com/media/file.mp4",
  "status": "processing",
  "progress": 45,
  "createdAt": "2023-05-10T15:30:00Z",
  "updatedAt": "2023-05-10T15:35:00Z"
}

Get All Jobs

GET /jobs

Retrieve all jobs for the authenticated user.

Request (API Key)
Response

curl -X GET https://api.shrinked.com/jobs?limit=20&offset=0 \
  -H "x-api-key: YOUR_API_KEY"

{
  "jobs": [
    {
      "id": "job123456",
      "jobName": "Example Job 1",
      "status": "completed",
      "createdAt": "2023-05-10T15:30:00Z"
    },
    {
      "id": "job789012",
      "jobName": "Example Job 2",
      "status": "processing",
      "createdAt": "2023-05-11T10:15:00Z"
    }
  ],
  "total": 45,
  "limit": 20,
  "offset": 0
}

Restart Job

POST /jobs/ID/restart

Restart a failed or completed job.

Request (API Key)
Response

curl -X POST https://api.shrinked.com/jobs/job123456/restart \
  -H "x-api-key: YOUR_API_KEY"

{
  "id": "job123456",
  "status": "restarted",
  "message": "Job restarted successfully"
}

Export Doc

POST /jobs/exportdoc/DOC_ID

Export a processed document.

Request (API Key)
Response

curl -X POST https://api.shrinked.com/jobs/exportdoc/doc123456 \
  -H "x-api-key: YOUR_API_KEY"

{
  "message": "Document export initiated."
}

Get Job By Result ID

GET /jobs/by-result/resultId

Retrieve a job using its result ID.

Request (API Key)
Response

curl -X GET https://api.shrinked.com/jobs/by-result/result123456 \
  -H "x-api-key: YOUR_API_KEY"

{
  "id": "job123456",
  "jobName": "Example Job",
  "scenario": "SINGLE_FILE_DEFAULT",
  "email": "[email protected]",
  "lang": "en",
  "isPublic": true,
  "createPage": false,
  "link": "https://example.com/media/file.mp4",
  "status": "completed",
  "resultId": "result123456",
  "createdAt": "2023-05-10T15:30:00Z",
  "completedAt": "2023-05-10T16:00:00Z"
}

Job Processing Scenarios

Scenario	Description
`SINGLE_FILE_DEFAULT`	Process a single media file with default settings
`YOUTUBE_VIDEO`	Process a YouTube video
`AUDIO_ONLY`	Process audio content only
`TRANSCRIPT_ONLY`	Generate only a transcript without further processing
`FULL_ANALYSIS`	Perform comprehensive analysis including transcript, summary, and insights

Job Status Values

created

Job has been created but not yet started

queued

Job is in the processing queue

processing

Job is actively being processed

completed

Job has completed successfully

failed

Job processing has failed

cancelled

Job has been cancelled

API Key Authentication

The Jobs API supports API key authentication for easy server-to-server integration. To use API key authentication, include your API key in the x-api-key header:

x-api-key: YOUR_API_KEY

You can use either the standard endpoints with the API key header, or the dedicated /jobs/key endpoints. Both approaches are supported and functionally equivalent.

Learn more about authentication methods and managing API keys.