# Utility Endpoint API (https://www.socialcrawl.dev/platforms/utility/endpoint)

> Complete usage guide for a single endpoint: every parameter with type, description and example, the exact credit cost, cache behaviour, pagination recipe, a copy-paste example request, an example response, the response schema URL, and related endpoints. Identify the endpoint by id (tiktok/profile) or url (/v1/tiktok/profile). Free to call.

TL;DR: `GET /v1/utility/endpoint` 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 |
| --- | --- | --- |
| `id` | no | Endpoint id as platform/resource, e.g. tiktok/profile |
| `url` | no | Endpoint path form, e.g. /v1/tiktok/profile (a full https URL also works) |
| `method` | no | Disambiguates resources registered under more than one HTTP method (GET \| POST) |

## Code example

```bash
curl "https://www.socialcrawl.dev/v1/utility/endpoint" \
  -H "x-api-key: sc_YOUR_API_KEY"
```

## FAQ

### How do I get the usage guide for a specific endpoint?

Call GET /v1/utility/endpoint with id set to the platform/resource pair (id=tiktok/profile) or url set to the path form (url=/v1/tiktok/profile). If a resource is registered under more than one HTTP method, add method=GET or method=POST to disambiguate.

### What does the endpoint usage guide include?

Everything needed to make a correct first call: every parameter with type, description, and example, the exact credit cost and billing rules, cache behaviour, the pagination recipe, a copy-paste example request, an example response with its schema URL, and a short list of related endpoints.

### Does the endpoint guide cost credits?

No, it is free at 0 credits, like the catalog, quickstart, and llms endpoints. You can look up as many guides as you need while wiring an integration and only spend credits when you call the data endpoints themselves.

### How does the guide stay in sync with the API?

The guide is generated from the same endpoint registry that routes and bills requests, so the parameters, costs, and examples it shows are the ones the API enforces. When an endpoint changes, its guide changes with it.

### How do AI agents use the endpoint guide?

It is the second step of self-onboarding: after discovering an endpoint in /v1/utility/endpoints, an agent fetches its guide, reads the parameter list, and builds a valid request from the included example, without inventing paths or scraping documentation.

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:

- How do I learn the parameters of a SocialCrawl endpoint programmatically?
- Which API returns a usage guide for one of its own endpoints?