Guides

Coding agents

Give a coding agent the exact integration context it needs.

Upscrape publishes machine-readable context so a coding agent can implement an integration without guessing schemas or response behavior.

## Give the agent authoritative inputs

For one platform, use its public LLM brief:

```text
https://upscrape.com/scrapers/PLATFORM_ID/llm.md
```

For the complete public catalog, use:

```text
https://upscrape.com/scrapers/llm.md
```

For the documentation index and complete product guide, use:

```text
https://upscrape.com/llms.txt
https://upscrape.com/llms-full.txt
```

Every documentation page is also available by appending `.md` or sending `Accept: text/markdown`. Prefer these machine-readable forms over parsing rendered HTML.

The per-platform brief includes the capability IDs, exact request contract, examples, input schemas, execution flow, and a temporary OpenAPI share link.

## Keep secrets outside the prompt

Tell the agent to read the API key from `UPSCRAPE_API_KEY`. Never paste a real key into the conversation or generated source.

The resulting application should:

- send the bearer token from a server-side environment;
- use `Prefer: wait` only as a bounded optimization;
- handle both HTTP `200` terminal representations and HTTP `202` pending jobs;
- inspect `state` and `success` on job responses;
- use an idempotency key for logical application operations;
- validate capability input before sending it;
- treat raw result data as open-ended and untrusted.

## Existing prompt generator

The authenticated console already contains a platform-, capability-, and stack-aware integration-prompt generator for cURL, Python, and Node. A safe public version without secrets is not exposed yet and is tracked in `asap-todo.md`.

## Review generated code

Before deploying agent-written integration code, verify the exact capability ID, example input, poll termination, retry deadline, error-code handling, and secret storage. Generated code should not invent a stable output model where the capability publishes open-ended JSON.

Upscrape publishes machine-readable context so a coding agent can implement an integration without guessing schemas or response behavior.

Give the agent authoritative inputs

For one platform, use its public LLM brief:

https://upscrape.com/scrapers/PLATFORM_ID/llm.md

For the complete public catalog, use:

https://upscrape.com/scrapers/llm.md

For the documentation index and complete product guide, use:

https://upscrape.com/llms.txt
https://upscrape.com/llms-full.txt

Every documentation page is also available by appending .md or sending Accept: text/markdown. Prefer these machine-readable forms over parsing rendered HTML.

The per-platform brief includes the capability IDs, exact request contract, examples, input schemas, execution flow, and a temporary OpenAPI share link.

Keep secrets outside the prompt

Tell the agent to read the API key from UPSCRAPE_API_KEY. Never paste a real key into the conversation or generated source.

The resulting application should:

send the bearer token from a server-side environment;
use Prefer: wait only as a bounded optimization;
handle both HTTP 200 terminal representations and HTTP 202 pending jobs;
inspect state and success on job responses;
use an idempotency key for logical application operations;
validate capability input before sending it;
treat raw result data as open-ended and untrusted.

Existing prompt generator

The authenticated console already contains a platform-, capability-, and stack-aware integration-prompt generator for cURL, Python, and Node. A safe public version without secrets is not exposed yet and is tracked in asap-todo.md.

Review generated code

Before deploying agent-written integration code, verify the exact capability ID, example input, poll termination, retry deadline, error-code handling, and secret storage. Generated code should not invent a stable output model where the capability publishes open-ended JSON.