# Upscrape YouTube Scraper LLM Integration Prompt

Give this to an LLM or coding agent. It must fetch the OpenAPI spec first and use this brief only for orientation.

## First Step

Fetch and read this OpenAPI spec before writing code:

https://data.upscrape.com/catalog/platforms/youtube/openapi.json?token=SFMyNTY.g2gDdAAAAAFtAAAAC3BsYXRmb3JtX2lkbQAAAAd5b3V0dWJlbgYA00rYSp8BYgABUYA.dy37XhMSHD4bTTEUPHo1yMwzPOwh-Cm-woKd1q9LBOk
This signed OpenAPI URL is valid for approximately 7 days.

## Hard Rules

- Use the OpenAPI spec as the source of truth for endpoints, request bodies, response bodies, errors, and JSON schemas.
- Do not infer fields from capability descriptions; fetch the spec and use its component schemas.
- Authenticate every request with `Authorization: Bearer YOUR_API_KEY`.
- Start runs with `POST /execute`; do not invent platform-specific execute endpoints.
- Poll `GET /jobs/{id}` or `GET /jobs/{id}/result` until `state` is `completed` or `failed`.
- Optionally send `Prefer: wait=N` on `POST /execute` to wait up to N seconds for inline results.
- If the response is `200`, the job completed — read `results[0].data`. If `202`, poll `GET /jobs/{id}`.
- `stream` is public-facing but must remain `false` today.

## API Base

- Base URL: `https://data.upscrape.com`
- OpenAPI spec: `https://data.upscrape.com/catalog/platforms/youtube/openapi.json?token=SFMyNTY.g2gDdAAAAAFtAAAAC3BsYXRmb3JtX2lkbQAAAAd5b3V0dWJlbgYA00rYSp8BYgABUYA.dy37XhMSHD4bTTEUPHo1yMwzPOwh-Cm-woKd1q9LBOk`
- Execute endpoint: `POST /execute`
- Job poll endpoint: `GET /jobs/{id}`
- Result alias: `GET /jobs/{id}/result`
- Content-Type: `application/json`
- Optional header: `Idempotency-Key`
- Optional header: `Prefer: wait=N` (hold connection up to N seconds for synchronous result)

## Execution Flow

1. Send `POST /execute` with a platform capability ID and its `input` object.
2. The API responds with a queued `job_id`.
3. Poll the job endpoint until `state` becomes `completed` or `failed`.
4. If completed, read `results[0].data`; its exact shape is defined by the OpenAPI component schema for the selected capability.

## Example Execute Request

```json
{
  "capability": "youtube.channel-community.list",
  "input": {
    "limit": 3,
    "url": "https://www.youtube.com/@MrBeast"
  }
}
```

## Optional Request Fields

- `network.session_id`: explicit reusable session identifier
- `network.session_key`: stable key used to derive a reusable session
- `network.sticky`: reuse the resolved session when `true`
- `timeout_ms`: per-capability timeout override up to the capability maximum listed below
- `stream`: must be `false`

## Supported Capabilities

- `youtube.channel-community.list` - List Channel Community. Stream community posts from a channel's community tab. Max `timeout_ms`: 120000. Streaming: disabled.
- `youtube.channel-playlists.list` - List Channel Playlists. Stream playlists from a channel's playlists tab. Max `timeout_ms`: 120000. Streaming: disabled.
- `youtube.channel-shorts.list` - List Channel Shorts. Stream shorts from a channel's shorts tab. Max `timeout_ms`: 120000. Streaming: disabled.
- `youtube.channel-videos.list` - List Channel Videos. Stream videos from a channel's videos tab with pagination. Max `timeout_ms`: 120000. Streaming: disabled.
- `youtube.channel.get` - Get Channel. Fetch metadata for a YouTube channel. Max `timeout_ms`: 60000. Streaming: disabled.
- `youtube.comments.list` - List Comments. Stream comments for a YouTube video. Max `timeout_ms`: 120000. Streaming: disabled.
- `youtube.playlist.get` - Get Playlist. Fetch metadata and videos for a YouTube playlist. Max `timeout_ms`: 60000. Streaming: disabled.
- `youtube.search.query` - Search. Search YouTube for videos, channels, and playlists. Max `timeout_ms`: 60000. Streaming: disabled.
- `youtube.transcript.get` - Get Transcript. Fetch transcript and caption segments for a YouTube video. Max `timeout_ms`: 60000. Streaming: disabled.
- `youtube.video.get` - Get Video. Fetch metadata, streaming data, and engagement stats for a single YouTube video. Max `timeout_ms`: 60000. Streaming: disabled.