utility

Find the endpoint for a task

Describe what you want in plain words, in any language ("last 200 comments on this TikTok <url>", "German Instagram creators about matcha") and get the three endpoints most likely to do it, best first: each with its method and path, the parameters your words already filled (only values you typed, never made up), the ones still missing, the credits that one call would hold (null with a note when it cannot be quoted yet), a confidence and a one-line reason, plus a few alternatives. Act on the top result only when uncertain is false. When no endpoint matches what the task means, or the matcher is unavailable, the results are keyword guesses and uncertain is always true. A request to act on an account (post, reply, like, follow, message, delete), about your own account or customers, or about billing returns no results (reason not_a_data_job) and the nearest reads as alternatives. A search value that names no topic (a placeholder such as "keyword", a country name, an English phrase for a Korean or Chinese platform, or most of the sentence) is left out and listed under missing, with a note saying why. A task that lists several topics or names several markets carries topics or markets (ISO codes) and is uncertain. Pass platform to keep the answer on one platform. Nothing is run. Free to call.

get/utility/find

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/utility/find
  • Auth: API key in header x-api-key

Query parameters

taskstring

The job in plain words, in any language. Up to 600 characters are read. Provide this or query (one of: task, query; at least one required)

querystring

Alias for task. Provide this or task (one of: task, query; at least one required)

platformstring

Keep the answer on one platform slug (tiktok, instagram, ...). Omit to search every platform

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "utility",
  "endpoint": "/v1/utility/find",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.