> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration. ## This page - **On-site (HTML):** - **Markdown (.mdx) URL:** ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route). - **OpenAPI JSON:** ## Recommended docs entrypoints (this site) - [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown). - [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope. - [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages. - [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples. - [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths. - [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install. - [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 910 endpoint tools, plus docs_search/docs_read for implementation help. - [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples. - [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start. - [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog. - [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI). - [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls). - [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist. - [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping. - [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages. - [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance. - [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs. - Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract. ## Markdown docs convention - Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`). - Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`). - Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`). --- # Write a query from a description (https://www.socialfetch.dev/docs/api/v1/query/suggest/post) ## Summary Write a Boolean query from a plain-language description of what to monitor, optionally with example posts it should and shouldn't find, or refine an existing… **Tags:** `System` ## HTTP - **Method:** POST - **Path:** `/v1/query/suggest` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** HTTP only today - **Pagination:** none ## Credits - **Base:** 0 credits per successful lookup. - **Maximum on success (200):** 0 credits. - **Failed requests (`lookup_failed`, `503`):** not charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Request body - **Required:** yes; content type `application/json` **Shape:** - **brief** (required) — type `string`; maxLength: 2000. What to monitor, in plain words and any language: brands, people, topics, places, what to leave out. With `previousQuery`, the change to make to that query, such as `also exclude job ads`. - **examples** (optional) — type `object`. Example posts, to check the query against and to help write it. - **shouldMatch** (optional) — type `array`. Posts the query should find. - _items:_ - type `string`; minLength: 1; maxLength: 1000 - **shouldNotMatch** (optional) — type `array`. Posts the query should leave out. - _items:_ - type `string`; minLength: 1; maxLength: 1000 - **languages** (optional) — type `array`. Languages the posts should be in, as two-letter ISO 639-1 codes. Any language when omitted. - _items:_ - type `string`; pattern: `^[a-z]{2}$` - **platforms** (optional) — type `array`. Platforms to plan for. Every platform when omitted. - _items:_ - type `string`; enum: twitter, reddit, youtube, tiktok, linkedin, threads, instagram, hackernews, facebook - **previousQuery** (optional) — type `string`; minLength: 1; maxLength: 8192. A query in Social Fetch's syntax to refine as `brief` asks, instead of writing a new one. - **explainIn** (optional) — type `string`; enum: en, es. Language of the explanation, the note and the refusal: `en` (default) or `es`. - **maxCredits** (optional) — type `integer`; minimum: 1; maximum: 10000. Credits a search would be allowed, for the plan and its estimate. Default 100. **Example:** ```json { "brief": "string", "examples": { "shouldMatch": [ "string" ], "shouldNotMatch": [ "string" ] }, "languages": [ "string" ], "platforms": [ "twitter" ], "previousQuery": "string", "explainIn": "en", "maxCredits": 0 } ``` ## Responses (status codes) - **200**: A query written by AI and checked: its explanation, plan, estimate and how it reads your example posts. Or why none was written (`status: refused`). - **400**: Malformed request body, such as a blank description. - **401**: Missing or invalid API key - **429**: Rate limit exceeded for this free endpoint - **500**: Unexpected error - **503**: Writing a query is unavailable right now; retry after `Retry-After` seconds. ## Response body (200) A query written by AI and checked: its explanation, plan, estimate and how it reads your example posts. Or why none was written (`status: refused`). ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **status** (required) — type `string`; enum: suggested, refused. Whether a query was suggested, or why not in `refusal`. - **refusal** (required) — type `object`; nullable. Why no query was suggested; null when one was. - **reason** (required) — type `string`; enum: not_a_brief, no_valid_query, unusable_answer. `not_a_brief`: the description names no posts to monitor. `no_valid_query`: no query that reads correctly could be written for it. `unusable_answer`: the answer couldn't be used. - **message** (required) — type `string`. What to do instead, in plain language. - **query** (required) — type `string`; nullable. The suggested query, as written. Review it before searching with it. - **normalizedQuery** (required) — type `string`; nullable. The query with every operator explicit. It always parses back to the same query. - **explanation** (required) — type `string`; nullable. What the query finds, in plain language. Written from the query itself, so it always says what the query does. - **platformSearches** (optional) — type `object`. Searches suggested for a platform where what's planned from the query would search badly (Instagram's hashtags, say), by platform, to send as `platformSearches`. Absent when the plan needs none. Written by AI. - **twitter** (optional) — type `array`. Searches to run on this platform instead of those planned from the query, in its own syntax (Instagram: hashtags, with or without `#`). Posts found are still checked against the whole query. - _items:_ - type `string`; minLength: 1; maxLength: 200 - **reddit** (optional) — type `array`. Searches to run on this platform instead of those planned from the query, in its own syntax (Instagram: hashtags, with or without `#`). Posts found are still checked against the whole query. - _items:_ - type `string`; minLength: 1; maxLength: 200 - **youtube** (optional) — type `array`. Searches to run on this platform instead of those planned from the query, in its own syntax (Instagram: hashtags, with or without `#`). Posts found are still checked against the whole query. - _items:_ - type `string`; minLength: 1; maxLength: 200 - **tiktok** (optional) — type `array`. Searches to run on this platform instead of those planned from the query, in its own syntax (Instagram: hashtags, with or without `#`). Posts found are still checked against the whole query. - _items:_ - type `string`; minLength: 1; maxLength: 200 - **linkedin** (optional) — type `array`. Searches to run on this platform instead of those planned from the query, in its own syntax (Instagram: hashtags, with or without `#`). Posts found are still checked against the whole query. - _items:_ - type `string`; minLength: 1; maxLength: 200 - **instagram** (optional) — type `array`. Searches to run on this platform instead of those planned from the query, in its own syntax (Instagram: hashtags, with or without `#`). Posts found are still checked against the whole query. - _items:_ - type `string`; minLength: 1; maxLength: 200 - **threads** (optional) — type `array`. Searches to run on this platform instead of those planned from the query, in its own syntax (Instagram: hashtags, with or without `#`). Posts found are still checked against the whole query. - _items:_ - type `string`; minLength: 1; maxLength: 200 - **hackernews** (optional) — type `array`. Searches to run on this platform instead of those planned from the query, in its own syntax (Instagram: hashtags, with or without `#`). Posts found are still checked against the whole query. - _items:_ - type `string`; minLength: 1; maxLength: 200 - **note** (required) — type `string`; nullable. A short note on the choices made, such as names or exclusions added. Written by AI. - **examples** (required) — type `object`. How the query reads each example post, in the order sent. - **shouldMatch** (required) — type `array` - _items:_ - **shouldNotMatch** (required) — type `array` - _items:_ - **platforms** (required) — type `array`. The plan on each platform. - _items:_ - **platform** (required) — type `string`; enum: twitter, reddit, youtube, tiktok, linkedin, threads, instagram, hackernews, facebook. A platform a query can search. - **coverage** (required) — type `string`; enum: full, partial, none. `full`: every part of the query can be searched; `partial`: some can't (see notes); `none`: nothing can. - **notes** (required) — type `array`. What won't be covered, and why. - _items:_ - type `string` - **searchTerms** (required) — type `array`. What would be searched, in the platform's own syntax. - _items:_ - type `string` - **estimatedCredits** (required) — type `integer`; minimum: 0. At most what this platform would charge: its share of `maxCredits`, or less when its searches need fewer. - **custom** (optional) — type `boolean`. True when `searchTerms` are the searches chosen in `platformSearches`, not those planned from the query. Absent otherwise. - **estimatedCredits** (required) — type `integer`; minimum: 0. At most what a search with this query would charge. - **warnings** (required) — type `array`. Plain-language cautions, most important first. - _items:_ - type `string` - **aiGenerated** (required) — type `boolean`; enum: true. Always true: the query was written by AI. Nothing runs until you search with it. - **meta** (required) — type `object`. Metadata describing the request and billing outcome. - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call. - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request. - **version** (required) — type `string`; enum: v1. Public API version that served the response. ### Example JSON (OpenAPI example) ```json { "data": { "status": "suggested", "refusal": null, "query": "(\"Lumora Foods\" OR Lumora OR #LumoraFoods) AND (recall* OR lawsuit* OR demanda* OR \"food poisoning\" OR intoxicación) AND NOT (hiring OR vacante) AND (lang:en OR lang:es)", "normalizedQuery": "(\"Lumora Foods\" OR Lumora OR #LumoraFoods) AND (recall* OR lawsuit* OR demanda* OR \"food poisoning\" OR intoxicación) AND NOT (hiring OR vacante) AND (lang:en OR lang:es)", "explanation": "Posts that ((mention “Lumora Foods” or “Lumora”) or use the hashtag #LumoraFoods), (mention a word starting with “recall”, a word starting with “lawsuit”, a word starting with “demanda”, “food poisoning” or “intoxicación”), (don't mention “hiring” and don't mention “vacante”) and (are in English (en) or are in Spanish…", "note": "Added Spanish words for lawsuits and food poisoning, and left out job ads.", "examples": { "shouldMatch": [ { "outcome": "match", "agrees": true, "matchedTerms": [ "\"Lumora Foods\"" ], "unevaluableFields": [] } ], "shouldNotMatch": [ { "outcome": "no-match", "agrees": true, "matchedTerms": [], "unevaluableFields": [] } ] }, "platforms": [ { "platform": "twitter", "coverage": "full", "notes": [], "searchTerms": [ "\"Lumora Foods\" OR Lumora OR #LumoraFoods" ], "estimatedCredits": 10 } ], "estimatedCredits": 18, "warnings": [], "aiGenerated": true }, "meta": { "requestId": "req_01example", "creditsCharged": 0, "version": "v1" } } ``` ### Machine-readable error codes When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime): - `bad_request` ## Error handling & retries Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status. - **400**: Malformed request body, such as a blank description. **Retry:** Fix the request; retrying the same invalid payload will not help. - **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help. - **429**: Rate limit exceeded for this free endpoint - **500**: Unexpected error - **503**: Writing a query is unavailable right now; retry after `Retry-After` seconds. **Retry:** Usually safe to retry with exponential backoff and jitter. ### Suggested client defaults - Send the API key using the `x-api-key` header on every request. - On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user. - On `402`, surface an actionable billing message rather than blind retries.