# Web Scraping Run Agent API (https://www.socialcrawl.dev/platforms/web/agent)

> Runs a model-neutral browser agent task and returns a SocialCrawl async job id (job_...). Poll it via GET /v1/web/jobs/{job_id}.

TL;DR: `POST /v1/web/agent` costs 25 credits per call and returns SocialCrawl's unified JSON schema. Single x-api-key auth, 100 free credits on signup.

## Parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `url` | yes | Starting URL folded into the agent instruction. |
| `prompt` | yes | Task instruction. |
| `model` | no | Agent model: spark-1-mini or spark-1-pro. (spark-1-mini \| spark-1-pro) |

## Code example

```bash
curl -X POST "https://www.socialcrawl.dev/v1/web/agent" \
  -H "x-api-key: sc_YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{"url":"https://example.com","prompt":"Find the pricing page."}'
```

## FAQ

### What does the Web Agent API return?

Starts a job where a browser agent follows your plain-language instruction on a site, returning a job id to poll for its answer. The response uses the same JSON envelope as every SocialCrawl endpoint, with the data, credits_used and request_id fields.

### When should I use the Web Agent endpoint?

Use it for tasks that need clicking and navigating to reach the data; for a page you can already name, scrape it.

### How much does the Web Agent API cost?

Each call costs 25 credits, so the 100 free credits every new account gets cover 4 calls. Credits for failed or empty calls are refunded automatically, and there is no subscription.

### What parameters does the Web Agent API need?

The required parameters are url (starting URL folded into the agent instruction), prompt (task instruction). It also accepts 1 optional parameter, listed on this page.

### How do I call the Web Agent API?

Send a POST request to https://www.socialcrawl.dev/v1/web/agent with a JSON body and your API key in the x-api-key header. An Authorization: Bearer header works too.

See the full Web Scraping API: https://www.socialcrawl.dev/platforms/web

## Pricing

- Standard endpoints: 1 credit per call
- Advanced endpoints: 5 credits per call
- Premium endpoints: 10 credits per call
- 100 free credits on signup, no credit card required. Cached responses cost 0 credits. Credit packs never expire.
- Full pricing: https://www.socialcrawl.dev/pricing

## Explore with AI

Questions this API answers, phrased for an AI assistant:

- What does the SocialCrawl Web Agent API return?
- How do I get Web Agent data with the SocialCrawl API?