Vid Kraken

https://vidkraken.com/docs
Admin
Vid Kraken provides a REST API and MCP server to download videos, extract media clips by timestamp,...
Tokens:5,794
Snippets:64
Trust Score:5.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### 200 response body for GET /me

Source: https://vidkraken.com/docs/endpoint/get-account

Example 200 response body for the /me endpoint. Shows the account name, email, plan details, and usage balances for download_count, bandwidth_mb, and info.

```json
{
  "name": "Jane Developer",
  "email": "jane@example.com",
  "plan": {
    "id": "starter",
    "renewsAt": 1758326400000,
    "canceledAt": null
  },
  "balances": {
    "download_count": {
      "granted": 1000,
      "used": 123,
      "remaining": 877,
      "unlimited": false,
      "resetsAt": 1758326400000
    },
    "bandwidth_mb": {
      "granted": 400000,
      "used": 52480,
      "remaining": 347520,
      "unlimited": false,
      "resetsAt": 1758326400000
    },
    "info": {
      "granted": 5000,
      "used": 310,
      "remaining": 4690,
      "unlimited": false,
      "resetsAt": 1758326400000
    }
  }
}
```

--------------------------------

### GET /me

Source: https://vidkraken.com/docs/endpoint/tag/account

Retrieves account information and balances for the authenticated user.

```APIDOC
## GET /me

### Description
Get account info & balances

### Method
GET

### Endpoint
/me

### Response
#### Success Response (200)
- Account details and balances

#### Response Example
{
  "account": {},
  "balances": {}
}
```

--------------------------------

### 200 Response: IN_PROGRESS

Source: https://vidkraken.com/docs/endpoint/get-download-status

Example 200 response body for a download job in progress. Contains the job ID, status, title, duration, URL, and format.

```json
{
  "jobId": "69cfc45e8a3b4d2f9c1e0a7b",
  "status": "IN_PROGRESS",
  "url": "https://youtu.be/dQw4w9WgXcQ",
  "format": "1080"
}
```

--------------------------------

### cURL request to GET /me

Source: https://vidkraken.com/docs/endpoint/get-account

Sends a GET request to the /me endpoint with the API key in the Authorization header. Replace the placeholder after 'Bearer ' with your actual API key.

```bash
curl -X GET "https://vidkraken.com/api/v2/me" \
  -H "Authorization: Bearer "
```

--------------------------------

### GET /info/{jobId}

Source: https://vidkraken.com/docs/endpoint/tag/info

Get the status of a video-info job.

```APIDOC
## GET /info/{jobId}

### Description
Get the status of a video-info job.

### Method
GET

### Endpoint
/info/{jobId}

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The ID of the video-info job.

### Response
#### Success Response (200)
- **status** (string) - The status of the job (e.g., pending, completed, failed).
- **metadata** (object) - The video metadata if the job is completed.

#### Response Example
{
  "status": "string",
  "metadata": {}
}
```

--------------------------------

### GET /client-download/{jobId}

Source: https://vidkraken.com/docs

Polls the status of a client download job and retrieves the direct download link when ready. This endpoint is free and does not count against quotas.

```APIDOC
## GET /client-download/{jobId}

### Description
Polls the status of a client download job and retrieves the direct download link when ready. This endpoint is free and does not count against quotas.

### Method
GET

### Endpoint
/client-download/{jobId}

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The job identifier returned by POST /client-download.

### Response
#### Success Response (200)
- **status** (string) - The job status.
- **downloadUrl** (string) - The direct download link.

#### Response Example
{
  "status": "completed",
  "downloadUrl": "https://cdn.example.com/video.mp4"
}
```

--------------------------------

### cURL GET /download/{jobId}

Source: https://vidkraken.com/docs/endpoint/get-download-status

Sends a GET request to the download status endpoint. Replace the placeholder job ID and token with real values. The response is a JSON object containing the job status and metadata.

```bash
curl -X GET "https://vidkraken.com/api/v2/download/string" \
  -H "Authorization: Bearer "
```

--------------------------------

### GET /download/{jobId}

Source: https://vidkraken.com/docs/endpoint/tag/download

Gets the status of a download job and polls for the CDN URL.

```APIDOC
## [GET] /download/{jobId}

### Description
Gets the status of a download job and polls for the CDN URL.

### Method
GET

### Endpoint
/download/{jobId}

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The identifier of the download job.

### Response
#### Success Response (200)
- **status** (string) - The status of the download job.
- **cdnUrl** (string) - The CDN URL for the downloaded video.

#### Response Example
{
  "status": "string",
  "cdnUrl": "string"
}

```

--------------------------------

### Successful response with pending status

Source: https://vidkraken.com/docs/endpoint/get-video-info-status

Example of a successful response when the video info job is still pending. The response includes the job ID and status.

```json
{
  "jobId": "6f9c1234-5e8a-4b2f-9c1e-0a7b69cfc45e",
  "status": "pending"
}
```

--------------------------------

### cURL request to get video info status

Source: https://vidkraken.com/docs/endpoint/get-video-info-status

Use this cURL command to send a GET request to the Vid Kraken API to retrieve the status of a video info job. Replace the placeholder job ID and API key with your actual values.

```bash
curl -X GET "https://vidkraken.com/api/v2/info/string" \
  -H "Authorization: Bearer "
```

--------------------------------

### GET /info/{jobId}

Source: https://vidkraken.com/docs

Polls the status of an info request and retrieves the metadata when ready. This endpoint is free and does not count against quotas.

```APIDOC
## GET /info/{jobId}

### Description
Polls the status of an info request and retrieves the metadata when ready. This endpoint is free and does not count against quotas.

### Method
GET

### Endpoint
/info/{jobId}

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The job identifier returned by POST /info.

### Response
#### Success Response (200)
- **status** (string) - The job status.
- **metadata** (object) - The video metadata.

#### Response Example
{
  "status": "completed",
  "metadata": {
    "title": "Example Video",
    "duration": 120
  }
}
```

--------------------------------

### GET /download/{jobId}

Source: https://vidkraken.com/docs/endpoint/get-download-status

Retrieves the status of a download job using the job ID returned from POST /download.

```APIDOC
## GET /download/{jobId}

### Description
Retrieves the status of a download job using the job ID returned from POST /download.

### Method
GET

### Endpoint
https://vidkraken.com/api/v2/download/{jobId}

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The `jobId` returned from `POST /download`.

#### Authorization
- **bearerAuth** - API key issued from the dashboard, sent as `Authorization: Bearer YOUR_API_KEY` in the header.

### Request Example
```
curl -X GET "https://vidkraken.com/api/v2/download/string" \
  -H "Authorization: Bearer "
```

### Response
#### Success Response (200)
- **jobId** (string) - The unique identifier for the download job.
- **status** (string) - The current status of the job (e.g., IN_PROGRESS).
- **title** (string) - The title of the video.
- **duration** (integer) - The duration of the video in seconds.
- **url** (string) - The URL of the video.
- **format** (string) - The requested format (e.g., 1080).

#### Response Example
```
{
  "jobId": "69cfc45e8a3b4d2f9c1e0a7b",
  "status": "IN_PROGRESS",
  "title": "Rick Astley - Never Gonna Give You Up",
  "duration": 213,
  "url": "https://youtu.be/dQw4w9WgXcQ",
  "format": "1080"
}
```

#### Error Responses
- **401** - Missing API key. Provide it as 'Bearer YOUR_API_KEY'.
  ```
  {
    "error": "Missing API key. Provide it as 'Bearer YOUR_API_KEY'"
  }
  ```
- **404** - Download job not found.
  ```
  {
    "error": "Download job not found"
  }
  ```
- **500** - Failed to enqueue download job.
  ```
  {
    "error": "Failed to enqueue download job"
  }
  ```
```

--------------------------------

### POST /download

Source: https://vidkraken.com/docs/endpoint/tag/download

Submits a server-side YouTube download job.

```APIDOC
## [POST] /download

### Description
Submits a server-side YouTube download job.

### Method
POST

### Endpoint
/download

### Response
#### Success Response (200)
- **jobId** (string) - The identifier for the submitted download job.

#### Response Example
{
  "jobId": "string"
}

```

--------------------------------

### POST /client-download

Source: https://vidkraken.com/docs

Fetches direct download links from YouTube, Instagram, TikTok, and Facebook. This is an account add-on and must be enabled by contacting support.

```APIDOC
## POST /client-download

### Description
Fetches direct download links from YouTube, Instagram, TikTok, and Facebook. This is an account add-on and must be enabled by contacting support.

### Method
POST

### Endpoint
/client-download

### Parameters
#### Request Body
- **url** (string) - Required - The video URL from a supported platform.

### Response
#### Success Response (200)
- **downloadUrl** (string) - The direct download link.

#### Response Example
{
  "downloadUrl": "https://cdn.example.com/video.mp4"
}
```

--------------------------------

### POST /info

Source: https://vidkraken.com/docs/endpoint/tag/info

Submit a video-info job to fetch metadata for a YouTube video without queueing a download.

```APIDOC
## POST /info

### Description
Submit a video-info job to fetch metadata for a YouTube video without queueing a download.

### Method
POST

### Endpoint
/info

### Parameters
#### Request Body
- **url** (string) - Required - The YouTube video URL to fetch metadata for.

### Response
#### Success Response (200)
- **jobId** (string) - The ID of the submitted job, used to query status.

#### Response Example
{
  "jobId": "string"
}
```

--------------------------------

### cURL request to list channel videos

Source: https://vidkraken.com/docs/endpoint/list-channel-videos

Sends a POST request to `https://vidkraken.com/api/v2/list-channel`, setting the API key in the `Authorization` header and providing `channelUrl` in the JSON body. Replace the empty Bearer token with your actual API key.

```bash
curl -X POST "https://vidkraken.com/api/v2/list-channel" \
  -H "Authorization: Bearer " \
  -H "Content-Type: application/json" \
  -d '{
    "channelUrl": "https://www.youtube.com/@RickAstleyYT"
  }'
```

--------------------------------

### Submit download job with cURL

Source: https://vidkraken.com/docs/endpoint/submit-download

Submits a download job for a YouTube video with audio format. Requires a valid API key in the Authorization header. The response contains a jobId to poll for status.

```bash
curl -X POST "https://vidkraken.com/api/v2/download" \
  -H "Authorization: Bearer " \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://youtu.be/dQw4w9WXcQ",
    "format": "audio"
  }'
```

--------------------------------

### POST /me/videos

Source: https://vidkraken.com/docs/endpoint/tag/account

Lists channel videos for the authenticated user's account.

```APIDOC
## POST /me/videos

### Description
List channel videos

### Method
POST

### Endpoint
/me/videos

### Response
#### Success Response (200)
- List of channel videos

#### Response Example
{
  "videos": []
}
```

--------------------------------

### cURL request to submit video info

Source: https://vidkraken.com/docs/endpoint/submit-video-info

Sends a POST request to the /api/v2/info endpoint with a YouTube URL. Requires an API key in the Authorization header.

```bash
curl -X POST "https://vidkraken.com/api/v2/info" \
  -H "Authorization: Bearer " \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://youtu.be/dQw4w9WgXcQ"
  }'
```

--------------------------------

### POST /info

Source: https://vidkraken.com/docs

Fetches metadata for a YouTube video without queueing a download. Returns video information such as title, duration, and thumbnail.

```APIDOC
## POST /info

### Description
Fetches metadata for a YouTube video without queueing a download. Returns video information such as title, duration, and thumbnail.

### Method
POST

### Endpoint
/info

### Parameters
#### Request Body
- **url** (string) - Required - The YouTube video URL to fetch metadata for.

### Response
#### Success Response (200)
- **title** (string) - The video title.
- **duration** (number) - The video duration in seconds.
- **thumbnail** (string) - The thumbnail URL.

#### Response Example
{
  "title": "Example Video",
  "duration": 120,
  "thumbnail": "https://img.youtube.com/vi/.../hqdefault.jpg"
}
```

--------------------------------

### Add VidKraken MCP server to Claude Code

Source: https://vidkraken.com/docs/mcp

Command to add the VidKraken MCP server to Claude Code. Run this in your terminal to connect Claude Code to VidKraken over HTTP. Requires a VidKraken account and OAuth approval.

```bash
claude mcp add --transport http vidkraken https://vidkraken.com/api/mcp/mcp
```

--------------------------------

### POST /list-channel

Source: https://vidkraken.com/docs/endpoint/tag/channel

This endpoint lists recent videos from a YouTube channel. It is a POST request to /list-channel.

```APIDOC
## POST /list-channel

### Description
List recent videos from a YouTube channel.

### Method
POST

### Endpoint
/list-channel

```

--------------------------------

### Error: Too many pending downloads

Source: https://vidkraken.com/docs/endpoint/submit-download

Error response when the number of pending downloads exceeds the limit of 100 queued or in progress jobs.

```json
{
  "error": "Too many pending downloads (100). Wait for some of your jobs to finish before submitting more (limit: 100 queued or in progress)."
}
```

--------------------------------

### Error response: Failed to enqueue download job

Source: https://vidkraken.com/docs/endpoint/list-channel-videos

A 500 error indicating a server-side failure when the download job could not be queued.

```json
{
  "error": "Failed to enqueue download job"
}
```

--------------------------------

### Successful download job response

Source: https://vidkraken.com/docs/endpoint/submit-download

Successful response when a download job is enqueued. Contains the jobId, video title, duration, status, and a message instructing to poll the status endpoint.

```json
{
  "jobId": "69c45e8a3b4d2f9c1e0a7b",
  "title": "Rick Astley - Never Gonna Give You Up",
  "duration": 213,
  "status": "IN_QUEUE",
  "message": "Download job enqueued. Poll GET /api/v2/download/{jobId} for status."
}
```

--------------------------------

### Error response: Missing API key

Source: https://vidkraken.com/docs/endpoint/list-channel-videos

A 401 error returned when the API key is not provided or invalid. The error message instructs to include it as `Bearer YOUR_API_KEY`.

```json
{
  "error": "Missing API key. Provide it as 'Bearer YOUR_API_KEY'"
}
```

--------------------------------

### Error: Credit limit reached

Source: https://vidkraken.com/docs/endpoint/submit-download

Error response when the account's credit limit has been reached.

```json
{
  "error": "Credit limit reached"
}
```

--------------------------------

### Response schema for list-channel

Source: https://vidkraken.com/docs/endpoint/list-channel-videos

The JSON response for a successful request (HTTP 200) contains a video list with `id`, `title`, and `channel` fields, plus an `entries` array with video details like `duration` and `view_count`. This is the schema structure.

```json
{
  "id": "string",
  "title": "string",
  "channel": "string",
  "channel_id": "string",
  "channel_url": "string",
  "entries": [
    {
      "id": "string",
      "title": "string",
      "url": "string",
      "duration": 0,
      "view_count": 0,
      "uploader": "string"
    }
  ]
}
```

--------------------------------

### Error response: Missing required field

Source: https://vidkraken.com/docs/endpoint/list-channel-videos

A 400 error returned when the `channelUrl` field is not provided in the request body.

```json
{
  "error": "Missing required field: url"
}
```

--------------------------------

### Error response for job not found

Source: https://vidkraken.com/docs/endpoint/get-video-info-status

Error response when the specified job ID does not exist or has expired.

```json
{
  "error": "Download job not found"
}
```

--------------------------------

### VidKraken MCP server URL

Source: https://vidkraken.com/docs/mcp

The remote MCP server URL for VidKraken. Use this when adding VidKraken as a custom connector in Claude or other MCP-compatible clients. Transport is Streamable HTTP and authentication is OAuth 2.1 with PKCE and Dynamic Client Registration.

```text
https://vidkraken.com/api/mcp/mcp
```
Tokens:
Raw