# Utility Explain Error API (https://www.socialcrawl.dev/platforms/utility/explain-error)

> Paste a failed response (its status and body) and get back the fault in plain words, the steps that fix it, a corrected request when the error's own details allow one, whether retrying the same request can succeed, and the docs link. Covers bad or misnamed parameters (including a value sent as a parameter name), missing parameters, invalid values, wrong paths, auth, credits, key limits, rate limits, upstream failures and not-found. Pass the body as JSON or base64url JSON (up to 8,000 characters) and, optionally, the request you sent as request (API keys in it are dropped). The answer is computed from the error type and details the API returned; nothing is fetched. Free to call.

TL;DR: `GET /v1/utility/explain-error` costs Free (0 credits) and returns SocialCrawl's unified JSON schema. Single x-api-key auth, 100 free credits on signup.

## Parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `status` | no | The HTTP status of the failed response. Optional when the body carries error.status |
| `body` | no | The pasted response body: the JSON error envelope (URL-encoded or base64url) or plain text. Up to 8,000 characters. Provide this or status |
| `request` | no | The request that failed, as a URL or /v1 path with its query string. Lets the answer return a corrected request. Credentials in it are dropped |

## Code example

```bash
curl -G "https://www.socialcrawl.dev/v1/utility/explain-error" \
  --data-urlencode "body={\"success\":false,\"error\":{\"type\":\"INVALID_REQUEST\",\"message\":\"Unknown query parameter 'handel'. Did you mean 'handle'?\",\"status\":400,\"details\":{\"unknown_parameters\":[\"handel\"],\"suggestions\":{\"handel\":\"handle\"}}}}" \
  -H "x-api-key: sc_YOUR_API_KEY"
```

## FAQ

### What does the Explain Error API return?

Returns the fault in plain words, the steps that fix it, a corrected request when the error's details allow one, whether retrying can succeed, and the docs link. 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 Explain Error endpoint?

Use it when a call failed and you have the status and body, instead of guessing at the fix. It fetches nothing. Free to call.

### How much does the Explain Error API cost?

This endpoint is free to call and uses no credits. Every new account still gets 100 free credits for the paid endpoints. Credits for failed or empty calls are refunded automatically, and there is no subscription.

### What parameters does the Explain Error API need?

Identify the target with one of body, status. It also accepts 3 optional parameters, all listed on this page.

### How do I call the Explain Error API?

Send a GET request to https://www.socialcrawl.dev/v1/utility/explain-error with the parameters above and your API key in the x-api-key header. An Authorization: Bearer header works too.

See the full Utility API: https://www.socialcrawl.dev/platforms/utility

## 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 Explain Error API return?
- How do I get Explain Error data with the SocialCrawl API?