> **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`). --- # Run a saved query now (https://www.socialfetch.dev/docs/api/v1/saved-queries/id/run/post) ## Summary Run a saved query now, outside its schedule. The run is one search and charges up to the query's maxCreditsPerRun, as POST /v1/query/search does; its matches… **Tags:** `Saved queries` ## HTTP - **Method:** POST - **Path:** `/v1/saved-queries/{id}/run` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** HTTP only today - **Accepted identifiers:** `id` (path) - **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_...`) ## Parameters ### `id` (path) - **Required:** yes - **Constraints:** type `string`; minLength: 1 - **Description:** The saved query's id. ## Responses (status codes) - **202**: The run started. It finishes in about a minute; see the query's runs and matches. - **400**: The saved query is paused, capped or broken: resume it first. - **401**: Missing or invalid API key - **403**: The caller's role in this workspace can't manage its saved queries. - **404**: Saved query not found, or not owned by this workspace. - **429**: A run of this saved query is still going. Retry after the `Retry-After` header. - **500**: Unexpected error ## Response body (202) The run started. It finishes in about a minute; see the query's runs and matches. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **id** (required) — type `string` - **versionId** (required) — type `string` - **trigger** (required) — type `string`; enum: schedule, manual - **status** (required) — type `string`; enum: running, succeeded, partial, failed. `succeeded`: every platform searched as far as the plan went; `partial`: some stopped short (time, credits, a failure), and what finished was kept; `failed`: nothing could be searched. - **startedAt** (required) — type `string` - **finishedAt** (required) — type `string`; nullable - **creditsCharged** (required) — type `integer` - **matchesFound** (required) — type `integer` - **matchesNew** (required) — type `integer` - **platforms** (required) — type `array`. How far the run's search got on each platform. - _items:_ - **platform** (required) — type `string`; enum: twitter, reddit, youtube, tiktok, linkedin, instagram, threads, hackernews. A platform a search runs on: `twitter` (X), `reddit`, `youtube`, `tiktok`, `linkedin`, `instagram` (searched by hashtag, so only posts that use the hashtag are found), `threads` (searched by plain words, one short page a search, so it can miss posts) or `hackernews` (stories and comments). More platforms follow. - **status** (required) — type `string`; enum: exhausted, capped, budget, deadline, unsearchable, failed. How far it got: `exhausted`, every search ran to its last page; `capped`, the platform's own limit on pages stopped it; `budget`, `maxCredits` did; `deadline`, the search ran out of time (what finished is returned); `unsearchable`, nothing in the query can be searched there; `failed`, every call failed. - **coverage** (required) — type `string`; enum: full, partial, none. `full`: every part of the query was searched; `partial`: some can't be (see notes); `none`: nothing could. - **notes** (required) — type `array`. What wasn't covered, and why. - _items:_ - type `string` - **searchTerms** (required) — type `array`. What was searched, in the platform's own syntax. - _items:_ - type `string` - **fetched** (required) — type `integer`; minimum: 0. Posts read. - **matched** (required) — type `integer`; minimum: 0. Posts the query matched, not counting those `filtered` left out. - **filtered** (required) — type `integer`; minimum: 0. Posts the query matched that the request's `noise` presets left out. - **creditsCharged** (required) — type `integer`; minimum: 0 - **errors** (required) — type `object`. Error codes of calls that failed, with how many. - **unevaluableFields** (required) — type `array`. Fields the query uses that this platform doesn't return. - _items:_ - type `string` - **error** (required) — type `string`; nullable - **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 (derived from schema) ```json { "data": { "id": "string", "versionId": "string", "trigger": "schedule", "status": "running", "startedAt": "string", "finishedAt": "string", "creditsCharged": 0, "matchesFound": 0, "matchesNew": 0, "platforms": [ { "platform": "twitter", "status": "exhausted", "coverage": "full", "notes": [ "string" ], "searchTerms": [ "string" ], "fetched": 0, "matched": 0, "filtered": 0, "creditsCharged": 0, "errors": {}, "unevaluableFields": [ "string" ] } ], "error": "string" }, "meta": { "requestId": "string", "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**: The saved query is paused, capped or broken: resume it first. **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. - **403**: The caller's role in this workspace can't manage its saved queries. - **404**: Saved query not found, or not owned by this workspace. - **429**: A run of this saved query is still going. Retry after the `Retry-After` header. - **500**: Unexpected error ### 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.