{"openapi":"3.1.0","info":{"title":"Ollagraph API","description":"**Ollagraph** is web infrastructure for AI agents — 92 endpoints across fetch, extract, audit, intelligence, and AEO/SEO families, 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\nRate limits and quotas are returned on every response in the `x-ratelimit-*` headers. Successful 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\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/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/password":{"post":{"summary":"Change My Password","description":"Change the signed-in user's password. Verifies the current password\nfirst. Existing API keys are unaffected — only dashboard login changes.","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/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.","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":"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/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.","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. The FanoutSpanProcessor's per-user cache picks\nup the deletion within 60 seconds; spans in flight at the moment of\ndeletion still go through.","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.","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}":{"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/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"}]},"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"}]},"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"}]},"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"}]},"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"}]},"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":"*"}]},"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"}]},"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"}]},"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"}]},"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","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","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}]},"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"},"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":"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":[]}]}