{"openapi":"3.1.0","info":{"title":"Vera API","description":"Public web extraction and search by Vera, a product by Waggle.","version":"1.1.0"},"paths":{"/v1/scrape":{"post":{"summary":"Api Scrape","operationId":"api_scrape_v1_scrape_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScrapePayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/company":{"post":{"summary":"V1 Company","operationId":"v1_company_v1_company_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/search":{"post":{"summary":"Api Search","operationId":"api_search_v1_search_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/youtube":{"post":{"summary":"V1 Youtube","operationId":"v1_youtube_v1_youtube_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/products":{"post":{"summary":"V1 Products","operationId":"v1_products_v1_products_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/contacts":{"post":{"summary":"V1 Contacts","operationId":"v1_contacts_v1_contacts_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/search/news":{"post":{"summary":"V1 Search News","operationId":"v1_search_news_v1_search_news_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/search/videos":{"post":{"summary":"V1 Search Videos","operationId":"v1_search_videos_v1_search_videos_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/seo/audit":{"post":{"summary":"V1 Seo Audit","operationId":"v1_seo_audit_v1_seo_audit_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeoPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/geo/analyze":{"post":{"summary":"V1 Geo Analyze","operationId":"v1_geo_analyze_v1_geo_analyze_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeoPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/seo/diff":{"post":{"summary":"V1 Seo Diff","operationId":"v1_seo_diff_v1_seo_diff_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeoDiffPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/reader/reddit":{"post":{"summary":"V1 Reader Reddit","operationId":"v1_reader_reddit_v1_reader_reddit_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedditPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/reader/wikipedia":{"post":{"summary":"V1 Reader Wikipedia","operationId":"v1_reader_wikipedia_v1_reader_wikipedia_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WikipediaPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/reader/youtube":{"post":{"summary":"V1 Reader Youtube","operationId":"v1_reader_youtube_v1_reader_youtube_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/YouTubeTranscriptPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/reader/reviews":{"post":{"summary":"V1 Reader Reviews","operationId":"v1_reader_reviews_v1_reader_reviews_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewProfilePayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sitemap":{"post":{"summary":"V1 Sitemap","operationId":"v1_sitemap_v1_sitemap_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitemapPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/geo/citations/track":{"post":{"summary":"V1 Geo Radar","operationId":"v1_geo_radar_v1_geo_citations_track_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoRadarPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/geo/radar":{"post":{"summary":"V1 Geo Radar","operationId":"v1_geo_radar_v1_geo_radar_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoRadarPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/seo/monitor":{"post":{"summary":"V1 Seo Monitor","operationId":"v1_seo_monitor_v1_seo_monitor_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeoMonitorPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/usage":{"get":{"summary":"Api Usage","operationId":"api_usage_v1_usage_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/collections":{"get":{"summary":"Listing","operationId":"listing_v1_collections_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"post":{"summary":"Create","operationId":"create_v1_collections_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionInput"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/collections/{job_id}":{"get":{"summary":"Detail","operationId":"detail_v1_collections__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Remove","operationId":"remove_v1_collections__job_id__delete","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/collections/{job_id}/results":{"get":{"summary":"Results","operationId":"results_v1_collections__job_id__results_get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"format","in":"query","required":false,"schema":{"enum":["json","csv"],"type":"string","default":"json","title":"Format"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":1,"title":"Page"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":100,"title":"Page Size"}},{"name":"download","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Download"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/collections/{job_id}/cancel":{"post":{"summary":"Cancel","operationId":"cancel_v1_collections__job_id__cancel_post","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/serp/{engine}":{"post":{"tags":["Search intelligence"],"summary":"Search on Google, Bing, DuckDuckGo, Brave or Yahoo","description":"Runs one search and returns the results page: the organic results with a tag for forums, video and shops, and, on Google, the page's own features (AI Overview, People Also Ask, Knowledge Graph). The map listings and shopping are add-ons you ask for in features. depth is how many results (1 to 100). A search made in the last 24 hours is answered from the cache at a lower price; set fresh to true to search live. The most the request can cost is held first, you are charged for what it returns, and the rest is given back. The charge is in the X-Vera-Credits-Used header. A failed request costs nothing. Send an Idempotency-Key header to retry safely.","operationId":"serp_v1_serp__engine__post","parameters":[{"name":"engine","in":"path","required":true,"schema":{"type":"string","description":"google, bing, duckduckgo, brave or yahoo. Any other is a 404.","title":"Engine"},"description":"google, bing, duckduckgo, brave or yahoo. Any other is a 404."},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Body"},"examples":{"search":{"summary":"A search in Dubai","value":{"q":"best coffee in dubai","gl":"ae","hl":"en","depth":10}},"with_local_pack":{"summary":"With the map listings","value":{"q":"coffee shop","location":"Dubai","gl":"ae","hl":"en","depth":10,"features":["organic","paa","ai_overview","local_pack"]}}}}}},"responses":{"200":{"description":"Vera's usual answer: request_id, data, credits_used and elapsed_ms. data is the search service's answer for this tool, unchanged (the example is cut down to a few fields). The charge is also in the X-Vera-Credits-Used header.","content":{"application/json":{"schema":{},"example":{"request_id":"6f1c1f0e-5d1e-4c7a-9a39-2b2b2d0f6a11","data":{"engine":"google","status":"success","query":"best coffee in dubai","depth":{"requested":10,"delivered":10,"has_more":false},"organic":[{"position":1,"title":"Best Coffee in Dubai","link":"https://example.com/coffee","snippet":"A guide to the city's roasters.","domain":"example.com"}],"provenance":{"credits_used":6,"cache_hit":false}},"credits_used":6,"elapsed_ms":1840}}}},"400":{"description":"The request could not be priced; the message says why. Nothing is charged."},"404":{"description":"Not a search engine Vera offers. Nothing is charged."},"422":{"description":"A field of the body is not accepted; the message says which. No charge."},"502":{"description":"The service behind this tool returned an error. Nothing is charged."},"503":{"description":"The tool is temporarily unavailable. Nothing is charged."},"504":{"description":"The service behind this tool took too long. Nothing is charged."}}}},"/v1/keywords/ideas":{"post":{"tags":["Search intelligence"],"summary":"Keyword ideas for a seed keyword","description":"Collects ideas for a seed from Google's autocomplete, People Also Ask and related searches, cleaned and de-duplicated, each with the sources it came from and an intent label (question, comparison, commercial, local or informational). Works in Arabic. It gives ideas, not search volumes. expand says how many autocomplete calls to make: none, questions (the default), alphabet or all; more calls cost more. The most the request can cost is held first, you are charged for what it returns, and the rest is given back. The charge is in the X-Vera-Credits-Used header. A failed request costs nothing. Send an Idempotency-Key header to retry safely.","operationId":"keyword_ideas_v1_keywords_ideas_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Body"},"examples":{"ideas":{"summary":"Ideas for a keyword","value":{"seed":"specialty coffee","gl":"ae","hl":"en","limit":50,"expand":"questions"}}}}}},"responses":{"200":{"description":"Vera's usual answer: request_id, data, credits_used and elapsed_ms. data is the search service's answer for this tool, unchanged (the example is cut down to a few fields). The charge is also in the X-Vera-Credits-Used header.","content":{"application/json":{"schema":{},"example":{"request_id":"6f1c1f0e-5d1e-4c7a-9a39-2b2b2d0f6a11","data":{"status":"success","seed":"specialty coffee","gl":"ae","hl":"en","count":1,"ideas":[{"keyword":"where to buy specialty coffee in dubai","sources":["autocomplete"],"intent":"question"}],"provenance":{"credits_used":60,"search_cache_hit":false}},"credits_used":60,"elapsed_ms":1840}}}},"400":{"description":"The request could not be priced; the message says why. Nothing is charged."},"404":{"description":"Not a search engine Vera offers. Nothing is charged."},"422":{"description":"A field of the body is not accepted; the message says which. No charge."},"502":{"description":"The service behind this tool returned an error. Nothing is charged."},"503":{"description":"The tool is temporarily unavailable. Nothing is charged."},"504":{"description":"The service behind this tool took too long. Nothing is charged."}}}},"/v1/ai/answers":{"post":{"tags":["Search intelligence"],"summary":"What AI assistants answer, and whether a brand is in it","description":"Puts a buyer's question to ChatGPT, Claude, Perplexity or Gemini and tells you whether your brand and your competitors are named in the answer, in what order, with the citations and cited domains behind it. engines picks the assistants (all of them when left out); samples asks the same question more than once, for a mention rate. An assistant that is not set up answers not_configured and costs nothing. Each call to an assistant is priced on its own, and Claude's cost the most. The most the request can cost is held first, you are charged for what it returns, and the rest is given back. The charge is in the X-Vera-Credits-Used header. A failed request costs nothing. Send an Idempotency-Key header to retry safely.","operationId":"ai_answers_v1_ai_answers_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Body"},"examples":{"answer":{"summary":"Is a brand in an assistant's answer?","value":{"prompt":"What are the best specialty coffee roasters in Dubai?","brand":"Roasters","brand_domain":"roasters.ae","competitors":["Other Roasters"],"country":"ae","language":"en","samples":1,"engines":["chatgpt"]}}}}}},"responses":{"200":{"description":"Vera's usual answer: request_id, data, credits_used and elapsed_ms. data is the search service's answer for this tool, unchanged (the example is cut down to a few fields). The charge is also in the X-Vera-Credits-Used header.","content":{"application/json":{"schema":{},"example":{"request_id":"6f1c1f0e-5d1e-4c7a-9a39-2b2b2d0f6a11","data":{"status":"success","prompt":"What are the best specialty coffee roasters in Dubai?","brand":"Roasters","brand_domain":"roasters.ae","competitors":["Other Roasters"],"samples_requested":1,"provenance":{"credits_used":200,"provider_calls":1}},"credits_used":200,"elapsed_ms":1840}}}},"400":{"description":"The request could not be priced; the message says why. Nothing is charged."},"404":{"description":"Not a search engine Vera offers. Nothing is charged."},"422":{"description":"A field of the body is not accepted; the message says which. No charge."},"502":{"description":"The service behind this tool returned an error. Nothing is charged."},"503":{"description":"The tool is temporarily unavailable. Nothing is charged."},"504":{"description":"The service behind this tool took too long. Nothing is charged."}}}},"/v1/geo/radar/query":{"post":{"tags":["Search intelligence"],"summary":"Citation radar for one query, in depth","description":"Looks at one topic query and your brand: how likely AI answers are to cite you (0 to 100), the forum threads worth joining, the list articles that name your competitors, the questions your site does not answer yet, and a brief for AI writers. Use /v1/geo/radar to check many queries at once with less depth. The most the request can cost is held first, you are charged for what it returns, and the rest is given back. The charge is in the X-Vera-Credits-Used header. A failed request costs nothing. Send an Idempotency-Key header to retry safely.","operationId":"geo_query_radar_v1_geo_radar_query_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Body"},"examples":{"radar":{"summary":"One topic, in depth","value":{"query":"best specialty coffee roasters in dubai","brand":"Roasters","domain":"roasters.ae","location":"Dubai","gl":"ae","hl":"en","depth":30}}}}}},"responses":{"200":{"description":"Vera's usual answer: request_id, data, credits_used and elapsed_ms. data is the search service's answer for this tool, unchanged (the example is cut down to a few fields). The charge is also in the X-Vera-Credits-Used header.","content":{"application/json":{"schema":{},"example":{"request_id":"6f1c1f0e-5d1e-4c7a-9a39-2b2b2d0f6a11","data":{"engine":"google","query":"best specialty coffee roasters in dubai","brand":"Roasters","domain":"roasters.ae","location":"Dubai","citation_probability_score":42,"provenance":{"credits_used":50}},"credits_used":50,"elapsed_ms":1840}}}},"400":{"description":"The request could not be priced; the message says why. Nothing is charged."},"404":{"description":"Not a search engine Vera offers. Nothing is charged."},"422":{"description":"A field of the body is not accepted; the message says which. No charge."},"502":{"description":"The service behind this tool returned an error. Nothing is charged."},"503":{"description":"The tool is temporarily unavailable. Nothing is charged."},"504":{"description":"The service behind this tool took too long. Nothing is charged."}}}},"/v1/company/footprint":{"post":{"tags":["Search intelligence"],"summary":"A company's footprint in search","description":"Audits how a company shows up in search: its own web properties, its social and reference profiles (Wikipedia, LinkedIn, Instagram, Crunchbase), its map listings, what third parties say about it and the questions people ask about the brand. /v1/company stays the company profile read from the company's own website. The most the request can cost is held first, you are charged for what it returns, and the rest is given back. The charge is in the X-Vera-Credits-Used header. A failed request costs nothing. Send an Idempotency-Key header to retry safely.","operationId":"company_footprint_v1_company_footprint_post","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Body"},"examples":{"footprint":{"summary":"A company's search footprint","value":{"company":"Roasters","domain":"roasters.ae","location":"Dubai","gl":"ae","hl":"en","depth":20}}}}}},"responses":{"200":{"description":"Vera's usual answer: request_id, data, credits_used and elapsed_ms. data is the search service's answer for this tool, unchanged (the example is cut down to a few fields). The charge is also in the X-Vera-Credits-Used header.","content":{"application/json":{"schema":{},"example":{"request_id":"6f1c1f0e-5d1e-4c7a-9a39-2b2b2d0f6a11","data":{"engine":"google","company":"Roasters","domain":"roasters.ae","location":"Dubai","provenance":{"credits_used":34}},"credits_used":34,"elapsed_ms":1840}}}},"400":{"description":"The request could not be priced; the message says why. Nothing is charged."},"404":{"description":"Not a search engine Vera offers. Nothing is charged."},"422":{"description":"A field of the body is not accepted; the message says which. No charge."},"502":{"description":"The service behind this tool returned an error. Nothing is charged."},"503":{"description":"The tool is temporarily unavailable. Nothing is charged."},"504":{"description":"The service behind this tool took too long. Nothing is charged."}}}}},"components":{"schemas":{"BrowserAction":{"properties":{"action":{"type":"string","enum":["click","fill","scroll"],"title":"Action"},"selector":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Selector"},"value":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Value"},"amount":{"anyOf":[{"type":"integer","maximum":10000.0,"minimum":-10000.0},{"type":"null"}],"title":"Amount"}},"additionalProperties":false,"type":"object","required":["action"],"title":"BrowserAction","description":"A bounded, auditable browser interaction for public rendered pages."},"CollectionInput":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","default":"Untitled collection"},"mode":{"type":"string","enum":["batch","crawl"],"title":"Mode","default":"batch"},"urls":{"items":{"type":"string"},"type":"array","maxItems":1000,"minItems":1,"title":"Urls"},"max_pages":{"type":"integer","maximum":1000.0,"minimum":1.0,"title":"Max Pages","default":5},"client_id":{"type":"string","maxLength":64,"minLength":1,"title":"Client Id"}},"type":"object","required":["urls"],"title":"CollectionInput"},"CompanyPayload":{"properties":{"domain":{"type":"string","maxLength":255,"minLength":3,"title":"Domain"}},"additionalProperties":false,"type":"object","required":["domain"],"title":"CompanyPayload"},"ContactPayload":{"properties":{"url":{"type":"string","maxLength":2048,"minLength":8,"title":"Url"}},"additionalProperties":false,"type":"object","required":["url"],"title":"ContactPayload"},"ExtractionRule":{"properties":{"selector":{"type":"string","maxLength":200,"minLength":1,"title":"Selector"},"attribute":{"anyOf":[{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_-]{0,63}$"},{"type":"null"}],"title":"Attribute"},"multiple":{"type":"boolean","title":"Multiple","default":false}},"additionalProperties":false,"type":"object","required":["selector"],"title":"ExtractionRule"},"GeoRadarPayload":{"properties":{"brand_domain":{"type":"string","maxLength":255,"minLength":3,"title":"Brand Domain"},"brand_name":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Brand Name"},"queries":{"items":{"type":"string"},"type":"array","maxItems":10,"minItems":1,"title":"Queries"},"country":{"anyOf":[{"type":"string","pattern":"^[a-zA-Z]{2}$"},{"type":"null"}],"title":"Country"},"client_id":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Client Id"}},"additionalProperties":false,"type":"object","required":["brand_domain","queries"],"title":"GeoRadarPayload"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ProductPayload":{"properties":{"url":{"type":"string","maxLength":2048,"minLength":8,"title":"Url"},"marketplace":{"anyOf":[{"type":"string","enum":["amazon","walmart","shopee"]},{"type":"null"}],"title":"Marketplace"}},"additionalProperties":false,"type":"object","required":["url"],"title":"ProductPayload"},"RedditPayload":{"properties":{"url":{"type":"string","maxLength":2048,"minLength":8,"title":"Url"},"client_id":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Client Id"}},"additionalProperties":false,"type":"object","required":["url"],"title":"RedditPayload"},"ReviewProfilePayload":{"properties":{"url":{"type":"string","maxLength":2048,"minLength":8,"title":"Url"},"client_id":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Client Id"}},"additionalProperties":false,"type":"object","required":["url"],"title":"ReviewProfilePayload"},"ScrapePayload":{"properties":{"url":{"type":"string","maxLength":2048,"minLength":8,"title":"Url"},"mode":{"type":"string","enum":["manual","auto"],"title":"Mode","default":"manual"},"max_cost":{"anyOf":[{"type":"integer","maximum":5.0,"minimum":1.0},{"type":"null"}],"title":"Max Cost"},"min_quality_score":{"anyOf":[{"type":"integer","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Min Quality Score"},"render":{"type":"boolean","title":"Render","default":false},"screenshot":{"type":"boolean","title":"Screenshot","default":false},"return_html":{"type":"boolean","title":"Return Html","default":false},"wait_ms":{"type":"integer","maximum":3000.0,"minimum":0.0,"title":"Wait Ms","default":500},"wait_for":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Wait For"},"extract":{"additionalProperties":{"$ref":"#/components/schemas/ExtractionRule"},"type":"object","maxProperties":10,"title":"Extract"},"actions":{"items":{"$ref":"#/components/schemas/BrowserAction"},"type":"array","maxItems":20,"title":"Actions"},"user_agent":{"anyOf":[{"type":"string","enum":["default","gptbot","oai-searchbot","chatgpt-user","claudebot","perplexitybot","google-extended","bingbot","googlebot"]},{"type":"null"}],"title":"User Agent"},"country":{"anyOf":[{"type":"string","pattern":"^[a-zA-Z]{2}$"},{"type":"null"}],"title":"Country"},"proxy_type":{"type":"string","enum":["auto","datacenter","residential"],"title":"Proxy Type","default":"auto"},"response_format":{"type":"string","enum":["text","markdown","all"],"title":"Response Format","default":"all"},"markdown":{"type":"boolean","title":"Markdown","default":false},"client_id":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Client Id"},"ignore_robots_on_unreadable":{"type":"boolean","title":"Ignore Robots On Unreadable","default":false}},"additionalProperties":false,"type":"object","required":["url"],"title":"ScrapePayload"},"SearchPayload":{"properties":{"query":{"type":"string","maxLength":500,"minLength":1,"title":"Query"},"country":{"type":"string","pattern":"^[a-z]{2}$","title":"Country","default":"us"},"language":{"type":"string","pattern":"^[a-z]{2}$","title":"Language","default":"en"},"limit":{"type":"integer","maximum":1000.0,"minimum":1.0,"title":"Limit","default":10},"boost":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Boost"},"client_id":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Client Id"}},"additionalProperties":false,"type":"object","required":["query"],"title":"SearchPayload"},"SeoDiffPayload":{"properties":{"before_url":{"type":"string","maxLength":2048,"minLength":8,"title":"Before Url"},"after_url":{"type":"string","maxLength":2048,"minLength":8,"title":"After Url"},"render":{"type":"boolean","title":"Render","default":false},"client_id":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Client Id"}},"additionalProperties":false,"type":"object","required":["before_url","after_url"],"title":"SeoDiffPayload"},"SeoMonitorPayload":{"properties":{"target_url":{"type":"string","maxLength":2048,"minLength":8,"title":"Target Url"},"compare_url":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}],"title":"Compare Url"},"baseline_snapshot":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Baseline Snapshot"},"webhook_url":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}],"title":"Webhook Url"},"webhook_secret":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Webhook Secret"},"alert_triggers":{"items":{"type":"string"},"type":"array","title":"Alert Triggers"},"render":{"type":"boolean","title":"Render","default":false},"country":{"anyOf":[{"type":"string","pattern":"^[a-zA-Z]{2}$"},{"type":"null"}],"title":"Country"},"client_id":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Client Id"}},"additionalProperties":false,"type":"object","required":["target_url"],"title":"SeoMonitorPayload"},"SeoPayload":{"properties":{"url":{"type":"string","maxLength":2048,"minLength":8,"title":"Url"},"render":{"type":"boolean","title":"Render","default":false},"country":{"anyOf":[{"type":"string","pattern":"^[a-zA-Z]{2}$"},{"type":"null"}],"title":"Country"},"client_id":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Client Id"}},"additionalProperties":false,"type":"object","required":["url"],"title":"SeoPayload"},"SitemapPayload":{"properties":{"url":{"type":"string","maxLength":2048,"minLength":8,"title":"Url"},"limit":{"type":"integer","maximum":1000.0,"minimum":1.0,"title":"Limit","default":100},"filter_pattern":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Filter Pattern"},"client_id":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Client Id"}},"additionalProperties":false,"type":"object","required":["url"],"title":"SitemapPayload"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VideoPayload":{"properties":{"url":{"type":"string","maxLength":2048,"minLength":8,"title":"Url"}},"additionalProperties":false,"type":"object","required":["url"],"title":"VideoPayload"},"WikipediaPayload":{"properties":{"entity":{"type":"string","maxLength":200,"minLength":1,"title":"Entity"},"language":{"type":"string","maxLength":10,"minLength":2,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$","title":"Language","default":"en"},"client_id":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Client Id"}},"additionalProperties":false,"type":"object","required":["entity"],"title":"WikipediaPayload"},"YouTubeTranscriptPayload":{"properties":{"url":{"type":"string","maxLength":2048,"minLength":8,"title":"Url"},"client_id":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Client Id"}},"additionalProperties":false,"type":"object","required":["url"],"title":"YouTubeTranscriptPayload"}},"securitySchemes":{"TakeItKey":{"type":"http","scheme":"bearer"},"VeraKey":{"type":"http","scheme":"bearer"},"PageflockKey":{"type":"http","scheme":"bearer"},"WaggleKey":{"type":"http","scheme":"bearer","description":"Legacy schema name for the same API-key authentication."}}},"servers":[{"url":"/api/vera","description":"Vera website"},{"url":"/api/takeit","description":"Legacy compatibility alias"},{"url":"/api/pageflock","description":"Legacy compatibility alias"},{"url":"/api/waggle","description":"Legacy compatibility alias"}],"security":[{"VeraKey":[]}],"x-supported-proxy-networks":["auto","datacenter"]}