{"openapi":"3.1.0","info":{"title":"Ollagraph API","description":"**Ollagraph** is web infrastructure for AI agents — 197 endpoints across fetch, extract, audit, intelligence, AEO/SEO, and vertical actors, all behind one Bearer token and one MCP server.\n\nEvery endpoint authenticates the same way: `Authorization: Bearer osk_…`. Your API key is created at [app.ollagraph.com](https://app.ollagraph.com/) and is shown once at creation time.\n\nSuccessful calls cost one credit (some premium endpoints cost 3–5); server-side failures refund automatically. See the [capabilities page](https://ollagraph.com/capabilities) for the full catalog and [docs](https://ollagraph.com/docs) for the operational contract.\n\n## Response headers (every response)\n\n| Header | What it tells you | Standard |\n| --- | --- | --- |\n| `x-request-id` | Stable correlation ID; pass back to support, grep in your logs. | de-facto |\n| `traceparent` | Our server-side OTel trace + span ID, so you can correlate with your own trace. | W3C Trace Context |\n| `server-timing` | Wall-clock breakdown: at minimum `total;dur=`. Renders natively in Chrome DevTools. | W3C Server-Timing |\n| `x-credits-cost` / `x-credits-charged` / `x-credits-balance` | Sticker cost, what we actually deducted, what's left after this call. | — |\n| `x-tier-used` | Which fetch tier served the call (`direct`, `render`, `residential`). | — |\n| `x-cascade-path` | Full ordered list of tiers we attempted before one succeeded. | — |\n| `x-ratelimit-limit` / `RateLimit-Limit` (and `-remaining` / `-reset`) | Token-bucket state for your plan. Both legacy GitHub-style and the IETF draft spelling are emitted. | IETF draft-ietf-httpapi-ratelimit-headers |\n| `Cache-Control: no-store` | Auto-set on every authenticated response so corporate proxies and CDNs don't cache your data. | RFC 7234 |\n| `Deprecation` + `Sunset` + `Link` | Set when you're calling a route scheduled for removal. Empty today; will surface here when we ever deprecate. | RFC 8594 + draft-ietf-httpapi-deprecation |\n| `Idempotency-Replayed: true` | Returned when an `Idempotency-Key` matched a cached response. | Stripe-style |\n\nFree tier: 1,000 credits on signup, every endpoint, no credit card.\n\n_Note: `api.qcrawl.com` continues to serve the same backend during the rebrand transition. New integrations should use `api.ollagraph.com`._","termsOfService":"https://ollagraph.com/legal/terms/","contact":{"name":"Ollagraph support","url":"https://ollagraph.com/contactus/","email":"support@ollagraph.com"},"license":{"name":"Commercial — see Terms of Service","url":"https://ollagraph.com/legal/terms/"},"version":"1.0.0"},"servers":[{"url":"https://api.ollagraph.com","description":"Production"},{"url":"https://api.qcrawl.com","description":"Legacy alias — same backend; new integrations should use api.ollagraph.com"}],"paths":{"/v1/scrape":{"post":{"summary":"Scrape Endpoint","operationId":"scrape_endpoint_v1_scrape_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScrapeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Scraping"]}},"/v1/scrape/batch":{"post":{"summary":"Batch Scrape Endpoint","operationId":"batch_scrape_endpoint_v1_scrape_batch_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchScrapeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Scraping"]}},"/v1/scrape/llm-ready":{"post":{"summary":"Scrape Llm Ready Endpoint","description":"Fetch a URL, extract the article body, chunk it for RAG ingest.\n\nReturns chunks sized for an embedding model's context window with\nconfigurable overlap. Each chunk carries byte offsets into the\nsource page so customers can attribute citations back to exact\npositions. The response shape is identical regardless of which fetch\npath was used; the `proxy_used` field carries a diagnostic label.","operationId":"scrape_llm_ready_endpoint_v1_scrape_llm_ready_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LlmReadyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Scraping"]}},"/v1/scrape/async":{"post":{"summary":"Scrape Async Endpoint","operationId":"scrape_async_endpoint_v1_scrape_async_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncScrapeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Scraping"]}},"/v1/scrape/batch/async":{"post":{"summary":"Batch Scrape Async Endpoint","operationId":"batch_scrape_async_endpoint_v1_scrape_batch_async_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncBatchScrapeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Scraping"]}},"/v1/jobs/{job_id}":{"get":{"summary":"Get Job Status","operationId":"get_job_status_v1_jobs__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Jobs"]}},"/v1/vscode/runs":{"post":{"tags":["Automation"],"summary":"Vscode Run Endpoint","description":"Run a VS Code UI test headless and get structured pass/fail + failure\nscreenshots. **Limited access** — the submitted code executes in an isolated\ncontainer with network access; authorized/own use only. Returns a job_id;\npoll `GET /v1/jobs/{job_id}`.","operationId":"vscode_run_endpoint_v1_vscode_runs_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VsCodeRunRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vscode/runs/{job_id}/screenshots/{filename}":{"get":{"tags":["Automation"],"summary":"Vscode Screenshot Proxy","description":"Stream a failure screenshot (PNG) from a completed VS Code run.\nOwnership-checked against the jobs table.","operationId":"vscode_screenshot_proxy_v1_vscode_runs__job_id__screenshots__filename__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"filename","in":"path","required":true,"schema":{"type":"string","title":"Filename"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/me":{"get":{"summary":"Get Me","operationId":"get_me_v1_me_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/me/webhook-secret/rotate":{"post":{"summary":"Rotate My Webhook Secret","description":"Generate a new webhook signing secret. The previous one becomes invalid\nimmediately - any signed callbacks already in-flight will verify against\nthe new secret, so callers should drain in-flight jobs before rotating.","operationId":"rotate_my_webhook_secret_v1_me_webhook_secret_rotate_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/me/webhooks/test":{"post":{"summary":"Test My Webhook","description":"Send a single signed test payload to `webhook_url` so the customer can\nverify their receiver before going live.\n\nUses the same signing scheme as production deliveries:\n X-Ollagraph-Signature: t=,v1=\nwhere the signed body is `.`. The customer recomputes\nthe HMAC with their webhook_secret (from `/v1/me`) and compares in\nconstant time. Reuses the same retry/timeout policy as the worker so the\nresult reflects what a real delivery would look like.","operationId":"test_my_webhook_v1_me_webhooks_test_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookTestRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/me/password":{"post":{"summary":"Change My Password","description":"Change the signed-in user's password. Verifies the current password\nfirst. Other browser sessions (dashboard keys) are revoked; the current\nsession and developer API keys are kept.","operationId":"change_my_password_v1_me_password_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangePasswordRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/me/delete":{"post":{"tags":["Account"],"summary":"Delete My Account","description":"Permanently delete the signed-in account and all associated data\n(API keys, usage log, credit ledger, OTel forwarders, personal org).\nIrreversible. GDPR/CCPA right-to-erasure.\n\nConfirmation: send `password` (password accounts) or `confirm_email`\n(OAuth-only accounts). If you OWN a team org that still has other members,\ndeletion is refused (409) until you transfer ownership\n(`POST /v1/orgs/{id}/transfer`) or remove the members. An active\nsubscription is cancelled at the next billing date before deletion.\n\nNo scraped content is ever stored on our side, and invoices live with the\npayment provider — so this removes your complete footprint here.","operationId":"delete_my_account_v1_me_delete_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAccountRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/me/export":{"get":{"tags":["Account"],"summary":"Export My Data","description":"Machine-readable export of all personal data we hold for the signed-in\naccount (GDPR Art. 20 portability). Returns a single JSON document as a\ndownload: profile, credit ledger, usage log (capped — see `usage.note`),\nAPI-key METADATA (the key secret is never recoverable, so it is never\nincluded), OTel forwarders (auth values masked), and org memberships.\n\nNo scraped content is stored on our side, so none appears here — the only\nURLs present are your own requested URLs from your usage log.","operationId":"export_my_data_v1_me_export_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/me/jobs":{"get":{"summary":"Get My Jobs","description":"Paginated async-job history for the dashboard Jobs view.","operationId":"get_my_jobs_v1_me_jobs_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/me/credits":{"get":{"summary":"Get My Credits","description":"Current credit balance + paginated credit ledger.","operationId":"get_my_credits_v1_me_credits_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/me/usage":{"get":{"summary":"Get My Usage","description":"Paginated request log for the dashboard Logs view. Filter by endpoint.\n\n`format=json` (default) returns the standard `{rows, limit, offset}` envelope.\n\n`format=csv` returns the same rows as a streaming `text/csv` response with\ncolumns: created_at, endpoint, url, status, time_ms, credits_charged,\ntier_used, request_id. The same `limit`, `offset`, and `endpoint` filters\napply. Closes the recurring \"compliance asked me to dump 30 days of API\ncalls\" ticket without forcing customers to hand-roll a paginated client.","operationId":"get_my_usage_v1_me_usage_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}},{"name":"endpoint","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endpoint"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","default":"json","title":"Format"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/me/requests/{request_id}":{"get":{"summary":"Get My Request","description":"Look up a specific request by its X-Request-ID.\n\nCustomers paste the ID they grep-found in their own observability stack\n(Datadog, Better Stack, Honeycomb, etc.) and we return the billing-side\nrecord: endpoint, URL, status, latency, credit cost, timestamp.\n\nReturns 404 if the request_id isn't found for this user. That can mean:\n- the ID is from a different account\n- the Redis stream hasn't drained yet (within ~1s of the call completing)\n- the request was an unauthenticated /health hit which we don't log","operationId":"get_my_request_v1_me_requests__request_id__get","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","title":"Request Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/me/cost-estimate":{"post":{"summary":"Cost Estimate","description":"Return what the next call to `endpoint` would cost this user.\n\nNo execution, no charge, no rate-limit consumption. Reads the same\n`ENDPOINT_CREDIT_COST` map the actual billing path uses, applies the\noptional residential-proxy surcharge, and honours BYPASS_PLANS\n(internal / superadmin → 0). Customers price-check before they commit.","operationId":"cost_estimate_v1_me_cost_estimate_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostEstimateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/me/usage/summary":{"get":{"summary":"Get My Usage Summary","description":"Pre-aggregated chart data for the dashboard Overview.","operationId":"get_my_usage_summary_v1_me_usage_summary_get","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","default":30,"title":"Days"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/me/forwarders":{"get":{"summary":"Get My Forwarders","description":"List the customer's configured OTel forwarders. Auth values are\nreturned masked (last 4 chars + asterisks); plaintext is never exposed.","operationId":"get_my_forwarders_v1_me_forwarders_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]},"post":{"summary":"Create My Forwarder","description":"Add a new OTel destination. Auth value is encrypted at rest.\n\nKicks an immediate background refresh of the FanoutSpanProcessor's\nforwarder cache so spans start fanning out to the new destination\nwithin a few milliseconds rather than waiting for the next 30 s\nperiodic tick.","operationId":"create_my_forwarder_v1_me_forwarders_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForwarderCreateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/me/forwarders/{forwarder_id}":{"delete":{"summary":"Delete My Forwarder","description":"Remove a forwarder.\n\nKicks an immediate background refresh so the deleted destination\nstops receiving spans within a few milliseconds — no privacy concern\nof continuing to forward to an endpoint the customer just removed.\nSpans already buffered inside the soon-to-be-shut-down\nBatchSpanProcessor still flush; spans created after the refresh\ncompletes do not.","operationId":"delete_my_forwarder_v1_me_forwarders__forwarder_id__delete","parameters":[{"name":"forwarder_id","in":"path","required":true,"schema":{"type":"integer","title":"Forwarder Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/me/forwarders/{forwarder_id}/test":{"post":{"summary":"Test My Forwarder","description":"Emit a single test span to the configured destination. Returns\nwhether the endpoint accepted it. Updates last_test_at/status/detail\ncolumns so the dashboard can show the result inline.","operationId":"test_my_forwarder_v1_me_forwarders__forwarder_id__test_post","parameters":[{"name":"forwarder_id","in":"path","required":true,"schema":{"type":"integer","title":"Forwarder Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/keys":{"get":{"summary":"List My Keys","description":"List the user's API keys (prefixes only - raw keys are never recoverable).","operationId":"list_my_keys_v1_keys_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]},"post":{"summary":"Create My Key","description":"Mint a new API key. The raw key is returned ONCE; we only store the hash.\n\nIf org_id is supplied (team-org keys), caller must already be a\nmember of that org — we 403 otherwise. The new key inherits its\nbilling context from the org.","operationId":"create_my_key_v1_keys_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKeyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/keys/{key_id}":{"patch":{"summary":"Update My Key","description":"Update an existing key's label, project_tag, or daily_cap_credits.\nproject_tag=\"\" clears the tag; daily_cap_credits=0 removes the cap.\nOnly the owning user can update.","operationId":"update_my_key_v1_keys__key_id__patch","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"type":"integer","title":"Key Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateKeyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]},"delete":{"summary":"Delete My Key","description":"Revoke an API key. Existing in-flight requests using it still complete;\nnew requests with the revoked key get 401.","operationId":"delete_my_key_v1_keys__key_id__delete","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"type":"integer","title":"Key Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/keys/{key_id}/rotate":{"post":{"summary":"Rotate My Key","description":"Rotate an API key: mint a replacement that inherits the old key's label,\nproject tag, org, and daily cap, then revoke the old key. The new raw key is\nreturned ONCE. In-flight requests on the old key complete; new requests with\nthe old key get 401. This is the self-service path for a leaked or lost key\n(previously the only option was delete + recreate).","operationId":"rotate_my_key_v1_keys__key_id__rotate_post","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"type":"integer","title":"Key Id"}},{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"]}},"/v1/extract/clean":{"post":{"summary":"Extract Clean Endpoint","operationId":"extract_clean_endpoint_v1_extract_clean_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Extraction"]}},"/v1/extract/structured":{"post":{"summary":"Extract Structured Endpoint","operationId":"extract_structured_endpoint_v1_extract_structured_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Extraction"]}},"/v1/extract/contacts":{"post":{"summary":"Extract Contacts Endpoint","description":"Pull emails, phone numbers, and social-profile URLs from a text/HTML\nblob the customer supplies. No fetch, no network — pure regex extraction.","operationId":"extract_contacts_endpoint_v1_extract_contacts_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractContactsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Extraction"]}},"/v1/extract/tables":{"post":{"summary":"Extract Tables Endpoint","description":"Extract every from an HTML blob as structured JSON.\nHeaders detected from or all-
first rows. Colspan/rowspan\nexpanded. No fetch — caller supplies the HTML.","operationId":"extract_tables_endpoint_v1_extract_tables_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractTablesRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Extraction"]}},"/v1/aeo/freshness-signal":{"post":{"summary":"Aeo Freshness Signal Endpoint","description":"Audit a page's freshness signals from schema.org dateModified,\nOpenGraph article:modified_time, HTTP Last-Modified, visible 'Updated'\ntext, and copyright year. Returns a 0-100 freshness score + the\nmost-recent dated signal + any inconsistencies between them.","operationId":"aeo_freshness_signal_endpoint_v1_aeo_freshness_signal_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshnessSignalRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["AEO"]}},"/v1/aeo/snippet-format-detect":{"post":{"summary":"Aeo Snippet Format Detect Endpoint","description":"Classify a page's content into the four featured-snippet shapes\nGoogle pulls from: paragraph, list, table, definition. Returns\ncounts + example snippets for each kind + a best-fit prediction.","operationId":"aeo_snippet_format_detect_endpoint_v1_aeo_snippet_format_detect_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnippetFormatDetectRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["AEO"]}},"/v1/aeo/heading-hierarchy-score":{"post":{"summary":"Aeo Heading Hierarchy Endpoint","description":"Audit H1-H6 hierarchy on a page. Surfaces missing H1, multiple H1s,\nhierarchy skips (H2 -> H4 without H3 between), and the count of\nquestion-style headings — important for AI Overview eligibility.","operationId":"aeo_heading_hierarchy_endpoint_v1_aeo_heading_hierarchy_score_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HeadingHierarchyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["AEO"]}},"/v1/seo/redirect-chain-map":{"post":{"summary":"Seo Redirect Chain Endpoint","description":"Trace the full redirect chain from a URL to its final destination.\nReturns the hops + SEO-flavored scoring: too-long chain, HTTPS->HTTP\ndowngrade, 302/307 used where 301 would be appropriate.","operationId":"seo_redirect_chain_endpoint_v1_seo_redirect_chain_map_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedirectChainMapRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["SEO"]}},"/v1/seo/broken-links-audit":{"post":{"summary":"Seo Broken Links Endpoint","description":"Scan a single page for broken outbound + internal links. HEAD\nprobe with GET fallback, parallel, configurable cap. Returns\nfull status code + final URL per link, with broken ones flagged.","operationId":"seo_broken_links_endpoint_v1_seo_broken_links_audit_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrokenLinksAuditRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["SEO"]}},"/v1/seo/anchor-text-audit":{"post":{"summary":"Seo Anchor Text Audit Endpoint","description":"Audit every on the page. Flags generic anchors\n('click here', 'read more') and over-optimized repeats (same exact-\nmatch anchor used 3+ times pointing at the same URL).","operationId":"seo_anchor_text_audit_endpoint_v1_seo_anchor_text_audit_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnchorTextAuditRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["SEO"]}},"/v1/seo/schema-validate":{"post":{"summary":"Seo Schema Validate Endpoint","description":"Validate JSON-LD blocks against Google's required-field lists for\n20+ rich-result types (Product, Recipe, Article, Event, FAQPage,\nHowTo, JobPosting, LocalBusiness, Review, ...). Returns the list of\ntypes the page is rich-result-eligible for.","operationId":"seo_schema_validate_endpoint_v1_seo_schema_validate_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"type":"string","title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaValidateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["SEO"]}},"/v1/seo/mixed-content":{"post":{"summary":"Seo Mixed Content Endpoint","description":"Find HTTP subresources loaded by an HTTPS page (mixed content).\nReports every , "},{"html":"

Doc

Drop links.

y","include_links":false}]},"IntelBlacklistRequest":{"properties":{"target":{"type":"string","title":"Target","description":"IPv4 address or domain to check."}},"type":"object","required":["target"],"title":"IntelBlacklistRequest","examples":[{"target":"8.8.8.8"},{"target":"spamhaus.org"}]},"IntelCaaRequest":{"properties":{"domain":{"type":"string","title":"Domain","description":"Apex domain. Returns its CAA records and which CAs may issue certs."}},"type":"object","required":["domain"],"title":"IntelCaaRequest","examples":[{"domain":"google.com"}]},"IntelCookiesRequest":{"properties":{"url":{"type":"string","title":"Url","description":"URL to fetch. Returns the Set-Cookie response headers parsed by RFC 6265 grammar."}},"type":"object","required":["url"],"title":"IntelCookiesRequest","examples":[{"url":"https://www.bbc.com/"}]},"IntelDnsPropagationRequest":{"properties":{"domain":{"type":"string","title":"Domain","description":"Domain to query across public resolvers."},"record_type":{"type":"string","title":"Record Type","description":"DNS record type: A, AAAA, MX, TXT, NS, CNAME, or SOA.","default":"A"}},"type":"object","required":["domain"],"title":"IntelDnsPropagationRequest","examples":[{"domain":"ollagraph.com","record_type":"A"}]},"IntelDnssecRequest":{"properties":{"domain":{"type":"string","title":"Domain","description":"Apex domain to probe for DNSSEC posture (DNSKEY + DS + AD-bit)."}},"type":"object","required":["domain"],"title":"IntelDnssecRequest","examples":[{"domain":"cloudflare.com"},{"domain":"example.com"},{"domain":"anthropic.com"}]},"IntelDomainRequest":{"properties":{"domain":{"type":"string","title":"Domain"}},"type":"object","required":["domain"],"title":"IntelDomainRequest","examples":[{"domain":"anthropic.com"}]},"IntelEmailAuthRequest":{"properties":{"domain":{"type":"string","title":"Domain","description":"Domain to inspect — e.g. example.com."}},"type":"object","required":["domain"],"title":"IntelEmailAuthRequest","examples":[{"domain":"google.com"},{"domain":"anthropic.com"}]},"IntelHeadersRequest":{"properties":{"url":{"type":"string","title":"Url","description":"URL to fetch. Must include scheme."}},"type":"object","required":["url"],"title":"IntelHeadersRequest","examples":[{"url":"https://anthropic.com"}]},"IntelHttpVersionsRequest":{"properties":{"url":{"type":"string","title":"Url","description":"An https:// URL to probe for HTTP/1.1, HTTP/2, and HTTP/3-advertised support."}},"type":"object","required":["url"],"title":"IntelHttpVersionsRequest","examples":[{"url":"https://cloudflare.com"},{"url":"https://example.com"}]},"IntelIpReputationRequest":{"properties":{"ip":{"type":"string","title":"Ip","description":"Public IPv4 or IPv6 address to classify."}},"type":"object","required":["ip"],"title":"IntelIpReputationRequest","examples":[{"ip":"8.8.8.8"},{"ip":"23.92.16.1"}]},"IntelNameserversRequest":{"properties":{"domain":{"type":"string","title":"Domain","description":"Apex domain. Returns its NS records plus the IPv4/IPv6 each NS resolves to."}},"type":"object","required":["domain"],"title":"IntelNameserversRequest","examples":[{"domain":"anthropic.com"}]},"IntelRedirectsRequest":{"properties":{"url":{"type":"string","title":"Url","description":"URL whose redirect chain you want to trace."}},"type":"object","required":["url"],"title":"IntelRedirectsRequest","examples":[{"url":"https://bit.ly/anthropic"}]},"IntelReverseDnsRequest":{"properties":{"ip":{"type":"string","title":"Ip","description":"An IPv4 or IPv6 address. Returns its PTR hostname if one is configured."}},"type":"object","required":["ip"],"title":"IntelReverseDnsRequest","examples":[{"ip":"1.1.1.1"},{"ip":"8.8.8.8"}]},"IntelRobotsRequest":{"properties":{"url":{"type":"string","title":"Url"},"user_agent":{"type":"string","title":"User Agent","default":"*"}},"type":"object","required":["url"],"title":"IntelRobotsRequest","examples":[{"url":"https://anthropic.com/pricing","user_agent":"*"}]},"IntelSecurityTxtRequest":{"properties":{"url":{"type":"string","title":"Url","description":"Any URL on the target — we derive the origin and probe /.well-known/security.txt then /security.txt."}},"type":"object","required":["url"],"title":"IntelSecurityTxtRequest","examples":[{"url":"https://google.com"}]},"IntelSocialTagsRequest":{"properties":{"url":{"type":"string","title":"Url","description":"Page to fetch. Returns Open Graph + Twitter Card + canonical + title + icons + lang + theme color."}},"type":"object","required":["url"],"title":"IntelSocialTagsRequest","examples":[{"url":"https://anthropic.com"}]},"IntelSriAuditRequest":{"properties":{"url":{"type":"string","title":"Url","description":"Page to fetch. Lists external scripts + stylesheets and flags which lack Subresource Integrity (SRI) pinning."}},"type":"object","required":["url"],"title":"IntelSriAuditRequest","examples":[{"url":"https://news.ycombinator.com"}]},"IntelUptimeRequest":{"properties":{"url":{"type":"string","title":"Url","description":"URL to probe."}},"type":"object","required":["url"],"title":"IntelUptimeRequest","examples":[{"url":"https://ollagraph.com"}]},"IntelUrlRequest":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"IntelUrlRequest","examples":[{"url":"https://anthropic.com"}]},"IntelWafRequest":{"properties":{"url":{"type":"string","title":"Url","description":"URL to probe. Detects Cloudflare/Akamai/Fastly/AWS WAF/Imperva/Sucuri/F5/ModSecurity/etc. from headers + body patterns."}},"type":"object","required":["url"],"title":"IntelWafRequest","examples":[{"url":"https://cloudflare.com"}]},"IntelWaybackRequest":{"properties":{"url":{"type":"string","title":"Url","description":"URL to look up in the Wayback Machine. Returns the first and last archived snapshot."}},"type":"object","required":["url"],"title":"IntelWaybackRequest","examples":[{"url":"https://anthropic.com"}]},"JsonRepairRequest":{"properties":{"text":{"type":"string","title":"Text"}},"type":"object","required":["text"],"title":"JsonRepairRequest","examples":[{"text":"{'name': 'Ada', age: 36, skills: ['math',]"}]},"KeywordExtractRequest":{"properties":{"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text","description":"Plain text to extract keywords from. Provide either `text` or `url`."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"URL to fetch — we'll extract the clean article body and run TextRank over it."},"top_k":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Top K","description":"How many top keywords + phrases to return.","default":20}},"type":"object","title":"KeywordExtractRequest","examples":[{"text":"Retrieval-augmented generation (RAG) is a technique that enables large language models (LLMs) to retrieve and incorporate new information from external data sources."},{"top_k":30,"url":"https://en.wikipedia.org/wiki/Retrieval-augmented_generation"}]},"LangDetectRequest":{"properties":{"text":{"type":"string","title":"Text"}},"type":"object","required":["text"],"title":"LangDetectRequest","examples":[{"text":"Bonjour, comment allez-vous aujourd'hui ?"}]},"LlmReadyRequest":{"properties":{"url":{"type":"string","title":"Url","description":"URL to fetch and chunk for RAG ingest."},"max_tokens":{"type":"integer","maximum":4096.0,"minimum":64.0,"title":"Max Tokens","description":"Target token budget per chunk. Default 512 (fits comfortably in embedding context windows).","default":512},"overlap_tokens":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Overlap Tokens","description":"Tokens to overlap between adjacent chunks. Default 15% of max_tokens."}},"type":"object","required":["url"],"title":"LlmReadyRequest","examples":[{"max_tokens":512,"url":"https://ollagraph.com/docs"},{"max_tokens":1024,"overlap_tokens":128,"url":"https://en.wikipedia.org/wiki/Retrieval-augmented_generation"}]},"LoginRequest":{"properties":{"email":{"type":"string","title":"Email"},"password":{"type":"string","title":"Password"}},"type":"object","required":["email","password"],"title":"LoginRequest"},"MixedContentRequest":{"properties":{"url":{"type":"string","title":"Url","description":"HTTPS URL to audit for HTTP subresources."}},"type":"object","required":["url"],"title":"MixedContentRequest","examples":[{"url":"https://ollagraph.com/"}]},"ParseEmailRequest":{"properties":{"email":{"type":"string","title":"Email"}},"type":"object","required":["email"],"title":"ParseEmailRequest","examples":[{"email":"Alex.B+work@gmail.com"}]},"ParseUrlRequest":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"ParseUrlRequest","examples":[{"url":"https://shop.example.co.uk/products/item?ref=ad&utm_source=fb#reviews"}]},"ParseUserAgentRequest":{"properties":{"user_agent":{"type":"string","title":"User Agent"}},"type":"object","required":["user_agent"],"title":"ParseUserAgentRequest","examples":[{"user_agent":"Mozilla/5.0 (iPhone; CPU iPhone OS 17_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.4 Mobile/15E148 Safari/604.1"}]},"PasswordForgotRequest":{"properties":{"email":{"type":"string","title":"Email","examples":["you@example.com"]}},"type":"object","required":["email"],"title":"PasswordForgotRequest"},"PasswordResetRequest":{"properties":{"token":{"type":"string","minLength":8,"title":"Token","examples":[""]},"new_password":{"type":"string","minLength":8,"title":"New Password","examples":["a-strong-new-password"]}},"type":"object","required":["token","new_password"],"title":"PasswordResetRequest"},"PdfToMarkdownRequest":{"properties":{"pdf_base64":{"type":"string","title":"Pdf Base64","description":"Base64-encoded PDF bytes. 1 MB body cap = ~750 KB raw PDF."},"max_pages":{"type":"integer","maximum":500.0,"minimum":1.0,"title":"Max Pages","description":"Maximum pages to process; defaults to 200.","default":200}},"type":"object","required":["pdf_base64"],"title":"PdfToMarkdownRequest","examples":[{"max_pages":50,"pdf_base64":""}]},"PptxToMarkdownRequest":{"properties":{"pptx_base64":{"type":"string","title":"Pptx Base64","description":"Base64-encoded .pptx PowerPoint bytes. Extracts titles, bullets, speaker notes. Image-only slides are flagged."}},"type":"object","required":["pptx_base64"],"title":"PptxToMarkdownRequest","examples":[{"pptx_base64":""}]},"RedirectChainMapRequest":{"properties":{"url":{"type":"string","title":"Url","description":"Starting URL. We trace the full chain to the final destination."}},"type":"object","required":["url"],"title":"RedirectChainMapRequest","examples":[{"url":"http://github.com"},{"url":"https://bit.ly/3xyz"}]},"SchemaValidateRequest":{"properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"URL to fetch and validate JSON-LD on."},"html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Html","description":"HTML to validate in place of fetching a URL."}},"type":"object","title":"SchemaValidateRequest","examples":[{"url":"https://schema.org/Product"}]},"ScrapeRequest":{"properties":{"url":{"type":"string","title":"Url"},"format":{"type":"string","enum":["markdown","html","text","links"],"title":"Format","default":"markdown"},"js_eval":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Js Eval"},"actions":{"anyOf":[{"items":{"type":"object"},"type":"array","maxItems":50},{"type":"null"}],"title":"Actions"},"wait_until":{"type":"string","title":"Wait Until","default":"load"},"stealth":{"type":"boolean","title":"Stealth","default":true},"timeout":{"type":"integer","maximum":60.0,"minimum":1.0,"title":"Timeout","default":30},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy"},"user_agent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Agent"},"solve_captcha":{"type":"boolean","title":"Solve Captcha","default":false},"captcha_action":{"type":"string","title":"Captcha Action","default":"submit"}},"type":"object","required":["url"],"title":"ScrapeRequest","examples":[{"format":"markdown","url":"https://example.com"},{"actions":[{"selector":".load-more","type":"click"},{"ms":1500,"type":"wait"}],"format":"html","url":"https://example.com/spa","wait_until":"networkidle0"}]},"SeoMetaAuditRequest":{"properties":{"url":{"type":"string","title":"Url","description":"Page URL to audit."},"use_residential_proxy":{"type":"boolean","title":"Use Residential Proxy","description":"When True, routes through our premium residential proxy pool to reach sites that block standard datacenter fetches. Bills +3 credits.","default":false}},"type":"object","required":["url"],"title":"SeoMetaAuditRequest","examples":[{"url":"https://ollagraph.com/architecture/"}]},"SeoReadabilityRequest":{"properties":{"text":{"type":"string","title":"Text","description":"Plain text (or text content extracted from HTML) to score for readability. Minimum 5 words."}},"type":"object","required":["text"],"title":"SeoReadabilityRequest","examples":[{"text":"Qcrawl returns clean structured data from any URL. Send a URL, pick a format, get back markdown, HTML, plain text, or links. Free tier covers 1,000 requests every month with no credit card required."}]},"SeoSnippetCandidatesRequest":{"properties":{"html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Html","description":"HTML to extract candidates from. Provide either `html` or `url`. Body limit 1 MB."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"Alternative: page URL to fetch and analyse. When supplied with `use_residential_proxy=true`, fetches with JS rendering — finds snippet candidates on JS-hydrated docs sites that have 0

tags in their server-rendered HTML."},"use_residential_proxy":{"type":"boolean","title":"Use Residential Proxy","description":"Only meaningful when `url` is supplied. Routes the fetch through our premium proxy pool with JS rendering. Bills +3 credits.","default":false},"max_per_kind":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Max Per Kind","description":"Cap per kind (paragraphs / lists / tables).","default":5}},"type":"object","title":"SeoSnippetCandidatesRequest","examples":[{"html":"

How big is the free tier?

The free tier covers 1,000 requests per month across every endpoint. No credit card is required at signup, and credits do not roll over between billing periods. Upgrade only when you need more.

"},{"url":"https://docs.stripe.com/api","use_residential_proxy":true}]},"SignupRequest":{"properties":{"email":{"type":"string","title":"Email"},"password":{"type":"string","title":"Password"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","default":""}},"type":"object","required":["email","password"],"title":"SignupRequest"},"SmartScrapeRequest":{"properties":{"url":{"type":"string","title":"Url"},"format":{"type":"string","title":"Format","default":"markdown"},"stealth":{"type":"boolean","title":"Stealth","default":true},"timeout":{"type":"integer","title":"Timeout","default":30},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy"},"actions":{"anyOf":[{"items":{"type":"object"},"type":"array","maxItems":50},{"type":"null"}],"title":"Actions"}},"type":"object","required":["url"],"title":"SmartScrapeRequest","examples":[{"format":"markdown","url":"https://example.com"}]},"SnippetFormatDetectRequest":{"properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"URL to fetch and analyse. Provide either `url` or `html`."},"html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Html","description":"HTML to analyse in place of fetching a URL."}},"type":"object","title":"SnippetFormatDetectRequest","examples":[{"url":"https://ollagraph.com/docs"}]},"SubdomainEnumerateRequest":{"properties":{"domain":{"type":"string","title":"Domain","description":"Apex domain to enumerate. We query Certificate Transparency logs (crt.sh) for every cert ever issued under it, then dedupe the SAN list."},"max_results":{"type":"integer","maximum":5000.0,"minimum":1.0,"title":"Max Results","description":"Hard cap on returned subdomains. Most companies fit under 500; large orgs (google, microsoft) need a higher cap.","default":500}},"type":"object","required":["domain"],"title":"SubdomainEnumerateRequest","examples":[{"domain":"stripe.com"},{"domain":"vercel.com","max_results":1000}]},"TextDiffRequest":{"properties":{"a":{"type":"string","title":"A"},"b":{"type":"string","title":"B"},"mode":{"type":"string","title":"Mode","default":"unified"}},"type":"object","required":["a","b"],"title":"TextDiffRequest","examples":[{"a":"line one\nline two","b":"line one\nline 2","mode":"unified"}]},"TextSimilarityRequest":{"properties":{"a":{"type":"string","title":"A"},"b":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"B"},"candidates":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Candidates"}},"type":"object","required":["a"],"title":"TextSimilarityRequest","examples":[{"a":"Ollagraph API","candidates":["Ollagraph","Olanode API","Qcrawl"]}]},"ThreatRequest":{"properties":{"indicator":{"type":"string","title":"Indicator","description":"A single indicator — IP, domain, URL, or file hash. The type is auto-detected and routed to the relevant free threat sources.","examples":["8.8.8.8"]}},"type":"object","required":["indicator"],"title":"ThreatRequest"},"TokenCountRequest":{"properties":{"text":{"type":"string","title":"Text"},"encoding":{"type":"string","title":"Encoding","default":"cl100k_base"}},"type":"object","required":["text"],"title":"TokenCountRequest","examples":[{"encoding":"cl100k_base","text":"How many tokens is this?"}]},"TranscribeRequest":{"properties":{"audio_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Audio Url","description":"HTTPS URL to an audio or video file to transcribe; we download it (size-capped, SSRF-guarded). Provide this OR audio_base64."},"audio_base64":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Audio Base64","description":"Base64-encoded audio bytes for short clips (up to ~3.75 MB). Provide this OR audio_url."},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language","description":"ISO language code (e.g. 'en') to skip auto-detection."}},"type":"object","title":"TranscribeRequest","examples":[{"audio_url":"https://example.com/clip.mp3"}]},"UpdateKeyRequest":{"properties":{"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"project_tag":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Tag","description":"New project tag (or empty string to clear)."},"daily_cap_credits":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Daily Cap Credits","description":"New daily cap in credits. Pass 0 to remove the cap."},"redact_query_string":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Redact Query String","description":"Toggle per-key query-string redaction in the usage log. Omit to leave unchanged."}},"type":"object","title":"UpdateKeyRequest"},"UrlReputationRequest":{"properties":{"url":{"type":"string","title":"Url","description":"URL to check against the URLhaus phishing/malware feed. The URL is matched locally — we do NOT fetch it.","examples":["http://malware.example/login"]}},"type":"object","required":["url"],"title":"UrlReputationRequest"},"ValidateJsonRequest":{"properties":{"data":{"title":"Data"},"schema":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Schema"}},"type":"object","required":["data"],"title":"ValidateJsonRequest","examples":[{"data":{"age":36,"email":"a@b.com"},"schema":{"properties":{"email":{"type":"string"},"age":{"type":"integer"}},"required":["email"],"type":"object"}}]},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VerifyResendRequest":{"properties":{"email":{"type":"string","title":"Email","examples":["you@example.com"]}},"type":"object","required":["email"],"title":"VerifyResendRequest"},"VsCodeRunRequest":{"properties":{"testCode":{"type":"string","maxLength":100000,"minLength":1,"title":"Testcode","description":"A Mocha test file using ExTester page objects (require('vscode-extension-tester')). Runs against a vanilla VS Code with a no-op extension installed."},"vscodeVersion":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vscodeversion","description":"Pin a VS Code version (e.g. '1.127.0'). Omit for the server default."}},"type":"object","required":["testCode"],"title":"VsCodeRunRequest","description":"Submit a VS Code UI test (Mocha + ExTester page objects) to run headless\nin an isolated container. Async — poll GET /v1/jobs/{job_id} for the result.","examples":[{"testCode":"const assert=require('assert');const {VSBrowser,ActivityBar}=require('vscode-extension-tester');describe('smoke',function(){this.timeout(180000);it('workbench renders',async()=>{await VSBrowser.instance.waitForWorkbench();const c=await new ActivityBar().getViewControls();assert.ok(c.length>0);});});","vscodeVersion":"1.127.0"}]},"WebhookTestRequest":{"properties":{"webhook_url":{"type":"string","title":"Webhook Url","description":"HTTPS URL to receive the signed test payload."}},"type":"object","required":["webhook_url"],"title":"WebhookTestRequest","examples":[{"webhook_url":"https://example.com/hooks/ollagraph"}]},"XlsxToMarkdownRequest":{"properties":{"xlsx_base64":{"type":"string","title":"Xlsx Base64","description":"Base64-encoded .xlsx Excel bytes. Each sheet rendered as a Markdown table."},"max_rows_per_sheet":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Max Rows Per Sheet","description":"Cap per sheet; past 1000 rows raw CSV is more useful than Markdown.","default":1000}},"type":"object","required":["xlsx_base64"],"title":"XlsxToMarkdownRequest","examples":[{"max_rows_per_sheet":500,"xlsx_base64":""}]}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"osk_… API key","description":"Pass your API key as `Authorization: Bearer osk_…`. Create or rotate keys at [app.ollagraph.com](https://app.ollagraph.com/)."},"AdminToken":{"type":"apiKey","in":"header","name":"X-Admin-Token","description":"Operator-only token. Not for customer use."}}},"tags":[{"name":"Scraping","description":"Fetch single URLs or batches. Smart routing picks fast HTTP for static pages, full stealth browser for dynamic ones."},{"name":"Extraction","description":"Turn raw HTML into clean article content or structured metadata (JSON-LD, OpenGraph, Microdata)."},{"name":"Intelligence","description":"Domain and IP intelligence: DNS, WHOIS, SSL certificates, IP geolocation, page tech stack, sitemap, robots.txt, email verification."},{"name":"Crawling","description":"Full-site crawl with depth, budget, and robots.txt controls. Results delivered via webhook or polled with the jobs endpoint."},{"name":"Captcha","description":"Solve reCAPTCHA v3 invisible challenges. v3 only — by design."},{"name":"Parsing","description":"Stateless, offline parsers: URL decomposition, User-Agent breakdown, email syntax + role/disposable/free-provider flags. No network calls."},{"name":"Conversion","description":"Pure HTML → Markdown transformation. No fetch — caller supplies the HTML."},{"name":"SEO","description":"On-page SEO audit: meta scoring, readability, candidate snippet extraction."},{"name":"AEO","description":"Answer Engine Optimization: AI-crawler allowlist audit, llms.txt validation for the post-ChatGPT search era."},{"name":"Account","description":"Identity, usage, credits, API keys, password, and webhook secret for the authenticated user."},{"name":"Authentication","description":"Sign up, log in, verify email, mint a session-scoped API key."},{"name":"Billing","description":"Subscribe, buy credit packs, manage the active subscription, and open the hosted billing portal."},{"name":"Automation","description":"Run VS Code UI tests headless (ExTester) and get structured pass/fail + failure screenshots. Limited access — submitted code executes in an isolated container; enabled per-account."},{"name":"Jobs","description":"Poll the status of any async job (scrape, batch, crawl)."},{"name":"Health","description":"Liveness probe for monitoring."},{"name":"Admin","description":"Operator-only endpoints. Requires X-Admin-Token header."}],"security":[{"BearerAuth":[]}]}