# Utility (/docs/utility)



Utility [#utility]

The utility platform is the developer experience surface that teaches you (or your AI agent) how to use the rest of the API.

* **Endpoint catalog.** `endpoints` returns a machine-readable catalog of every active SocialCrawl endpoint: path, method, credit cost, parameters, and a link to its usage guide. It is generated from the running registry at request time, so it never drifts from what is callable.
* **Per-endpoint usage guide.** `endpoint` explains a single endpoint end to end: every parameter with type and example, the exact credit cost, cache behaviour, the pagination recipe, a copy-paste request, and related endpoints. Identify the endpoint by `id` (`tiktok/profile`) or `url` (`/v1/tiktok/profile`).
* **Quickstart.** `quickstart` returns everything needed for a first successful call in one response.
* **Agent context.** `llms` serves the SocialCrawl context corpus for AI agents through the API, as markdown or structured JSON, so an agent with an API key can bootstrap itself in one call instead of scraping documentation pages.

All utility endpoints are free: they cost 0 credits and never consume credits.

Base URL: `/v1/utility/...`

Onboard in one call [#onboard-in-one-call]

`GET /v1/utility/quickstart` returns authentication, the base URL, the response envelope, the credit billing model, the error taxonomy, rate limits, pagination rules, and a copy-paste first request:

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

Pass `?platform=tiktok` to tailor the first-call example and links to one platform. From there, `/v1/utility/endpoints` lists what you can call and `/v1/utility/endpoint?id=tiktok/profile` shows exactly how to call it.

```bash
# Everything callable, filterable by platform, keyword, or method
curl "https://www.socialcrawl.dev/v1/utility/endpoints?platform=tiktok&search=comment" \
  -H "x-api-key: sc_your_api_key_here"

# How to call one of them, by id or by path
curl "https://www.socialcrawl.dev/v1/utility/endpoint?url=/v1/tiktok/profile" \
  -H "x-api-key: sc_your_api_key_here"
```

`endpoint` takes **either `id` or `url`** — one is required.

Bootstrapping an agent [#bootstrapping-an-agent]

`GET /v1/utility/llms` serves the SocialCrawl context corpus through the API itself, so an agent holding nothing but a key can learn the surface in one call rather than scraping documentation pages. `format` chooses markdown or structured JSON, and `platform` narrows the corpus to one platform when the full context is more than the agent needs.

```bash
curl "https://www.socialcrawl.dev/v1/utility/llms?platform=youtube&format=json" \
  -H "x-api-key: sc_your_api_key_here"
```

Because it is generated from the running registry at request time, it cannot drift from what is actually callable — which is the reason to prefer it over a cached copy of the docs.

Endpoints [#endpoints]

<PlatformEndpoints platform="utility" />

Notes [#notes]

* All endpoints use `GET` method with query parameters
* Authentication via `x-api-key` header
* All utility endpoints (`endpoints`, `endpoint`, `quickstart`, `llms`) are free to call
* Responses follow the unified SocialCrawl schema