Utility
Free endpoints that describe the API itself: the endpoint catalog, a per-endpoint usage guide, a one-call quickstart, and the AI-agent context payload
The utility platform is the API describing itself. Four endpoints answer "what can I call", "how do I call this one", "how do I make my first request", and "give my agent everything it needs to know". All four are free, cost 0 credits, and never consume credits.
Base URL: /v1/utility/...
Every response here is generated from the running registry at request time, so it cannot drift from what is actually callable. That is the reason to prefer these over a cached copy of the documentation.
What is in here, and when you need it
| You need | Call this |
|---|---|
| Everything needed for a first successful request | GET /v1/utility/quickstart |
| The list of what you can call, filtered | GET /v1/utility/endpoints |
| Exactly how to call one endpoint | GET /v1/utility/endpoint |
| A context payload to bootstrap an AI agent | GET /v1/utility/llms |
Quickstart
1. Onboard in one call
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.
curl "https://www.socialcrawl.dev/v1/utility/quickstart?platform=tiktok" \
-H "x-api-key: YOUR_API_KEY"Pass platform to tailor the first-call example and links to one platform.
2. Find and read the endpoint you want
# Everything callable, filterable by platform, keyword, or method
curl "https://www.socialcrawl.dev/v1/utility/endpoints?platform=tiktok&search=comment" \
-H "x-api-key: YOUR_API_KEY"
# 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: YOUR_API_KEY"Discover the surface
| Endpoint | Credits | What it returns | Key parameters |
|---|---|---|---|
GET /v1/utility/quickstart | 0 | Everything needed for a first successful call: auth, base URL, envelope, billing, errors, rate limits, pagination, a first request | platform |
GET /v1/utility/endpoints | 0 | A machine-readable catalog of every active endpoint: path, method, credit cost, parameters, and a link to its usage guide | platform, search, method |
GET /v1/utility/endpoint | 0 | One 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 | id or url, plus method |
endpoint takes either id (tiktok/profile) or url (/v1/tiktok/profile), and one of them is required. Pass method to disambiguate a resource registered under more than one HTTP method: /v1/web/monitors/{monitor_id} is GET, PATCH and DELETE. Omit it and the first registered method wins.
On endpoints, search is a case-insensitive substring filter over endpoint paths and summaries.
Bootstrap an agent
| Endpoint | Credits | What it returns | Key parameters |
|---|---|---|---|
GET /v1/utility/llms | 0 | The SocialCrawl context corpus, as markdown or as a structured object | platform, format (markdown or json) |
An agent holding nothing but a key can learn the surface in one call rather than scraping documentation pages. format defaults to markdown. platform narrows the corpus to one platform when the full context is more than the agent needs.
curl "https://www.socialcrawl.dev/v1/utility/llms?platform=youtube&format=json" \
-H "x-api-key: YOUR_API_KEY"All endpoints
4 endpoints available.
| Endpoint | Path | Credit Tier |
|---|---|---|
| How to use any endpoint | /v1/utility/endpoint | standard (0cr) |
| List every available endpoint | /v1/utility/endpoints | standard (0cr) |
| AI-agent context payload | /v1/utility/llms | standard (0cr) |
| Get started in one call | /v1/utility/quickstart | standard (0cr) |
Platform notes
- All four endpoints are free. They cost 0 credits and never consume credits, so polling them is safe.
endpointrequiresidorurl. Sending neither is a400.- All endpoints use
GETwith query parameters, authenticate with thex-api-keyheader, and return the unified SocialCrawl envelope.