# Upscrape Reddit 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/reddit/openapi.json?token=SFMyNTY.g2gDdAAAAAFtAAAAC3BsYXRmb3JtX2lkbQAAAAZyZWRkaXRuBgAL8gpKnwFiAAFRgA.qJ163sKDw6YzKwTJyVgMslfln5mp-996ZyZxGAcLl-g
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/reddit/openapi.json?token=SFMyNTY.g2gDdAAAAAFtAAAAC3BsYXRmb3JtX2lkbQAAAAZyZWRkaXRuBgAL8gpKnwFiAAFRgA.qJ163sKDw6YzKwTJyVgMslfln5mp-996ZyZxGAcLl-g`
- 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": "reddit.comments.list",
  "input": {
    "limit": 25,
    "subreddits": "SaaS"
  }
}
```

## 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

- `reddit.comments.list` - List Comments. Recent comments from one or more subreddits (or all of Reddit), newest first, with a cursor for the next page. Max `timeout_ms`: 30000. Streaming: disabled.
- `reddit.comments.search` - Search Comments. Search comments by query, newest first, optionally restricted to subreddits, with a cursor for the next page. Approximate; callers re-filter locally. Max `timeout_ms`: 30000. Streaming: disabled.
- `reddit.posts.list` - List Posts. Recent posts from one or more subreddits (or all of Reddit), newest first, with a cursor for the next page. Max `timeout_ms`: 30000. Streaming: disabled.
- `reddit.posts.search` - Search Posts. Search posts by query, newest first, optionally restricted to subreddits, with a cursor for the next page. Max `timeout_ms`: 30000. Streaming: disabled.
- `reddit.subreddit.get` - Get Subreddit. Fetch a single subreddit's public metadata by name. Max `timeout_ms`: 30000. Streaming: disabled.
- `reddit.subreddit.search` - Search Subreddits. Search communities by name or topic (typeahead-friendly), ordered by relevance, with subscribers and description. Max `timeout_ms`: 30000. Streaming: disabled.