{"openapi":"3.1.0","info":{"title":"Suprsonic API","version":"1.0.0","description":"Add dozens of capabilities to your AI agent with one API key. Suprsonic unifies search, scraping, enrichment, media generation, speech, and more into a single API - zero auth, always SOTA, automatic failover.\n\nNo provider authentication required. Suprsonic manages all provider subscriptions. You only need your Suprsonic API key (omk_). No OAuth, no per-provider keys, no token management.","termsOfService":"https://suprsonic.ai/terms","contact":{"name":"Suprsonic","url":"https://suprsonic.ai","email":"support@suprsonic.ai"},"x-logo":{"url":"https://o-mega.ai/images/o-mega_orb_icon.png","altText":"Suprsonic"}},"servers":[{"url":"https://suprsonic.ai"}],"security":[{"apiKey":[]}],"paths":{"/v1/agent":{"post":{"tags":["Suprsonic"],"summary":"Agent API","description":"O-mega Unified Agent API: single endpoint for all capabilities.\n\nInstead of calling separate endpoints, agents call this one endpoint and either name the capability they need\nwith its params, or describe what they need in `request` and the system routes it. Either way it runs the\ncapability's own handler and answers its envelope.","operationId":"agent","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/search":{"post":{"tags":["Suprsonic"],"summary":"Web Search","description":"Search the web with SERP, AI synthesis, or both. Returns, by mode: serp the organic results (title, url, snippet, position) with any knowledge graph and featured snippet; ai a written answer with the URLs it cites; deep both. Use for current facts, news and finding pages. To read one page in full use scrape; for a report built from many sources use research. Cost: serp 1 credit, ai 2 credits, deep 3 credits, charged only when a call succeeds.","operationId":"search","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/scrape":{"post":{"tags":["Suprsonic"],"summary":"Scrape","description":"Extract content from any URL as Markdown or HTML. Returns the page's content in the chosen format (Markdown by default) with its title, description and links. Use when you have a URL and need what the page says. Start with fast; use standard for pages that need JavaScript and thorough only for sites that block scrapers. To pull specific fields into JSON use documents; to see the page as an image use screenshot. Cost: fast 1 credit, standard 2 credits, thorough 5 credits, charged only when a call succeeds.","operationId":"scrape","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScrapeRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/profiles/find":{"post":{"tags":["Suprsonic"],"summary":"Profile Finder","description":"Find and enrich professional profiles. Returns the person's name, headline, current company and title, location, summary, experience, education, skills, photo URL and LinkedIn URL. Use to learn who a professional is and what they have done. For their work email use emails; for a company rather than a person use companies. Pass linkedin_url, or first_name and last_name; company helps find the right person. Cost: 3 credits, charged only when a call succeeds.","operationId":"profiles","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileFindRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/emails/find":{"post":{"tags":["Suprsonic"],"summary":"Email Finder","description":"Find professional email addresses. Returns the address with its confidence (0 to 1) and verification status. Use to find a named person's work email at a company. To check an address you already have use email-verify; for the person's background use profiles. Cost: 2 credits, charged only when a call succeeds.","operationId":"emails","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailFindRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/images/generate":{"post":{"tags":["Suprsonic"],"summary":"Image Generation","description":"Generate images from text prompts. Returns a hosted URL of the image and the same image as base64 (b64_json), with its content_type (image/png or image/jpeg, as the bytes are), the aspect ratio and the size used. Use to create a new picture from a description. To cut the background out of an existing image use bg-remove; to capture a web page use screenshot. Cost: 512px 1 credit, 1K 2 credits, 2K 3 credits, 4K 5 credits, charged only when a call succeeds.","operationId":"images","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageGenerateRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/speech/synthesize":{"post":{"tags":["Suprsonic"],"summary":"Text-to-Speech","description":"Convert text to speech audio. Returns the speech as base64 MP3 audio with its sample rate and bit rate (read from the audio itself) and the voice used. Use for spoken voice or narration, up to 2,000 characters a call. For sound effects or music use sound-generate. Cost: 2 credits, charged only when a call succeeds.","operationId":"tts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SynthesizeRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/speech/transcribe":{"post":{"tags":["Suprsonic"],"summary":"Speech-to-Text","description":"Transcribe audio to text with timestamps. Returns the transcript, its confidence, language and duration, and every word with its start and end time. Use for a short clip whose exact words and timings you need. For a long recording with several speakers use transcribe; for caption files use subtitle. Pass audio_url, or the audio itself as audio_base64. Cost: 2 credits, charged only when a call succeeds.","operationId":"stt","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__api__unified__speech__TranscribeRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/sounds/generate":{"post":{"tags":["Suprsonic"],"summary":"Sound Generation","description":"Generate sound effects and short music tracks from text prompts (NOT speech: use tts for spoken voice). Returns the audio as base64 with its format, sample rate and duration. Use for sound effects, ambience and short instrumental music. It produces no spoken words: for speech use tts. Cost: 4 credits, charged only when a call succeeds.","operationId":"sound-generate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoundGenerateRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/messages/send":{"post":{"tags":["Suprsonic"],"summary":"SMS","description":"Send SMS or WhatsApp messages. Default channel is SMS (reliable delivery). WhatsApp requires recipient opt-in: they must have messaged your Business number within 24 hours. Returns the message id, channel, recipient, sender number and send status. Sends a real message to a phone number: a sent message cannot be recalled, and every call sends a new one. Use it to text a number the user gave you. Cost: 1 credit, charged only when a call succeeds.","operationId":"sms","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__api__unified__messages__SendMessageRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/documents/extract":{"post":{"tags":["Suprsonic"],"summary":"Document Extraction","description":"Extract structured data from URLs or content. Returns the extracted data as JSON (shaped by your schema when you pass one), with the source URL and whether long content was truncated. Use to turn a page or a text into structured fields. For a page's full text use scrape; for invoices and receipts use invoice-parse. Pass url or content; extraction_prompt says what to extract, and schema fixes the shape of the JSON you get back. Cost: 3 credits, charged only when a call succeeds.","operationId":"documents","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentExtractRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/companies/find":{"post":{"tags":["Suprsonic"],"summary":"Company Enrichment","description":"Enrich company data by domain. Returns the company's name, description, industry, type, size, founding year, headquarters, employees, estimated revenue range, LinkedIn page, social links, logo and brand colors. Use for business facts about a company. For technical facts about its domain (WHOIS, DNS, SSL, hosting) use site-intel; for a person use profiles. Cost: 3 credits, charged only when a call succeeds.","operationId":"companies","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyFindRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/emails/verify":{"post":{"tags":["Suprsonic"],"summary":"Email Verification","description":"Check whether an email address takes mail, or is disposable. Returns the status (valid, invalid, unknown when the mailbox is neither confirmed nor rejected, or do_not_mail for a throwaway provider) with a sub-status, whether it is a free mailbox, and the domain's mail servers and provider. Use before emailing an address you were given or found. To find an address from a person's name use emails. Cost: 1 credit, charged only when a call succeeds.","operationId":"email-verify","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailVerifyRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/audio/transcribe":{"post":{"tags":["Suprsonic"],"summary":"Transcription","description":"Transcribe audio with speaker diarization and timestamps. Returns the full transcript with its confidence, language, duration, word and speaker counts, and the utterances, each with its speaker and start and end time. Use for meetings, interviews and podcasts, where who spoke when matters. For a short clip's word timings use stt; for caption files use subtitle. Cost: 3 credits, charged only when a call succeeds.","operationId":"transcribe","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__api__unified__transcription__TranscribeRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/invoices/parse":{"post":{"tags":["Suprsonic"],"summary":"Invoice Parsing","description":"Extract structured data from invoices and receipts. Returns the invoice number, dates, supplier and customer, currency, subtotal, tax, total and every line item. Use for an invoice or receipt given as a PDF or image URL. For any other document use documents with your own schema. Cost: 3 credits, charged only when a call succeeds.","operationId":"invoice-parse","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceParseRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/subtitles/generate":{"post":{"tags":["Suprsonic"],"summary":"Subtitles","description":"Generate SRT/VTT subtitles from audio or video. Returns the subtitles as SRT or VTT text with the language, duration and number of cues. Use to caption a video or an audio file. For a plain transcript use stt or transcribe. Cost: 2 credits, charged only when a call succeeds.","operationId":"subtitle","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitleRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/files/convert":{"post":{"tags":["Suprsonic"],"summary":"File Conversion","description":"Convert documents, web pages, spreadsheets and images between formats. Returns a download URL of the converted file with its name, size and formats. Use to change a file's format, for example Word to PDF or PDF to Markdown. To extract specific fields use documents; to read a web page's text use scrape. Cost: 2 credits, charged only when a call succeeds.","operationId":"file-convert","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileConvertRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/images/remove-background":{"post":{"tags":["Suprsonic"],"summary":"Background Removal","description":"Remove the background from any image, at the image's own size or a smaller one you choose. Returns a transparent PNG. Returns the cut-out as base64 and as a hosted URL, with its format, width and height: a PNG with a transparent background, or WebP (transparent) or JPG (set on white) when you ask for them. Use to isolate the subject of an existing image. To create a new image use images. Cost: 2 credits, charged only when a call succeeds.","operationId":"bg-remove","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BgRemoveRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/screenshots/capture":{"post":{"tags":["Suprsonic"],"summary":"Screenshot","description":"Capture a rendered screenshot of any webpage. Returns the image as base64 with its format, its own width and height (a full-page capture is as tall as the page) and its size in bytes. Use to see how a page looks. To read its text use scrape. Cost: 1 credit, charged only when a call succeeds.","operationId":"screenshot","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenshotRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/code/execute":{"post":{"tags":["Suprsonic"],"summary":"Code Execution","description":"Execute code in a secure sandbox with pre-configured environments. Returns stdout, stderr, the exit code, the run time, and the files the code wrote to /home/user/output/ as base64. Use for calculations, data processing and running scripts. Each call runs in a fresh sandbox that is destroyed afterwards, so nothing carries over from one call to the next. Cost: 2 credits, charged only when a call succeeds.","operationId":"code-execute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeExecuteRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/sites/intel":{"post":{"tags":["Suprsonic"],"summary":"Site Intelligence","description":"Get comprehensive domain intelligence: WHOIS, DNS, SSL, tech stack, email security, hosting. Returns, by mode, the registration (WHOIS) data, DNS records with email security, the technology stack, a security grade from A to F, or the subdomains; overview combines registration, DNS, SSL and hosting. Use for technical facts about a domain. For business facts about the company behind it use companies; to find a name you can register use domains. Cost: overview 2 credits, whois 1 credit, dns 1 credit, tech-stack 2 credits, security 2 credits, subdomains 2 credits, charged only when a call succeeds.","operationId":"site-intel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteIntelRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/research":{"post":{"tags":["Suprsonic"],"summary":"Deep Research","description":"Multi-step deep research: search, scrape, enrich entities, and synthesize into a cited report. Returns a report (title, summary, sections, key findings, confidence) with numbered sources and the people and companies it found, enriched. Use for a question that needs many sources and a synthesized, cited answer. It takes far longer and costs more than search, which suits a quick fact. Cost: standard 10 credits, deep 20 credits, comprehensive 35 credits, charged only when a call succeeds. Options change it: include_analysis true +5, academic in source_types +2, enrich_entities false -3, synthesis false -5.","operationId":"research","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/video/info":{"post":{"tags":["Suprsonic"],"summary":"Video Info","description":"Extract video metadata, available formats, and thumbnail from any URL. Returns the title, duration, thumbnail, uploader, upload date, view count, platform and the available formats with their sizes. Use to inspect a video before downloading it. To get the file use video-download; for what is said in it use transcribe. Cost: 1 credit, charged only when a call succeeds.","operationId":"video-info","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoInfoRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/video/download":{"post":{"tags":["Suprsonic"],"summary":"Video Download","description":"Download video from any URL and return a temporary download link. Returns a download link that expires after one hour, with the file name, size, duration, quality, format, title and thumbnail. A download that takes longer than about a minute and a half (a long video from any site) answers status processing with a job_id instead: call again with that job_id to get the file. A finished download includes its job_id too. Use to get a video, or only its audio, as a file. For its details without downloading use video-info. Cost: video 3 credits, audio 2 credits, charged only when a call succeeds.","operationId":"video-download","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoDownloadRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}},"/v1/domains":{"post":{"tags":["Suprsonic"],"summary":"Domains","description":"Find domain names and the extensions that fit a business. Returns, by mode, name ideas with prices, extensions that fit with reasons, one name across extensions, availability for a list of domains, prices per extension, or the extension catalog. Use to name a business or check domains before buying one; it never registers or buys a domain. For facts about a domain that is already live use site-intel. mode decides which fields apply: company_name and description for the suggest modes, query for search-extensions, domains for check-availability, tlds for pricing. Cost: suggest-names 5 credits, suggest-extensions 3 credits, search-extensions 2 credits, check-availability 1 credit, pricing 1 credit, tlds 1 credit, charged only when a call succeeds.","operationId":"domains","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainsRequest"}}},"required":true},"responses":{"200":{"description":"The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnifiedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"No API key, or one that was not found or is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"402":{"description":"Not enough credits for this call. The error's alternative_action says where to add them.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"403":{"description":"The account is restricted by a billing issue.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}},"429":{"description":"The key's rate limit is reached. The error's retry_after_seconds says when to try again.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/UnifiedError"}}}}}}}}}},"components":{"schemas":{"InvoiceParseRequest":{"properties":{"document_url":{"type":"string","title":"Document Url"}},"type":"object","required":["document_url"],"title":"InvoiceParseRequest"},"CodeExecuteRequest":{"properties":{"code":{"type":"string","maxLength":1000000,"title":"Code","description":"The code to execute"},"language":{"type":"string","title":"Language","description":"Programming language: python, javascript, or shell","default":"python"},"timeout":{"type":"integer","maximum":300.0,"minimum":1.0,"title":"Timeout","description":"Maximum execution time in seconds (1-300)","default":30},"template":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template","description":"Pre-configured environment: default, data-science, web-dev, video","default":"default"},"input_files":{"items":{"$ref":"#/components/schemas/InputFile"},"type":"array","title":"Input Files","description":"Files to upload to the sandbox before execution"},"packages":{"items":{"type":"string"},"type":"array","maxItems":20,"title":"Packages","description":"Additional pip packages to install before execution"}},"type":"object","required":["code"],"title":"CodeExecuteRequest","description":"Execute code in an isolated sandbox."},"VideoInfoRequest":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"VideoInfoRequest"},"CompanyFindRequest":{"properties":{"domain":{"type":"string","title":"Domain"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"}},"type":"object","required":["domain"],"title":"CompanyFindRequest"},"SoundGenerateRequest":{"properties":{"prompt":{"type":"string","title":"Prompt"},"duration_seconds":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Duration Seconds"},"prompt_influence":{"type":"number","title":"Prompt Influence","default":0.3},"output_format":{"type":"string","title":"Output Format","default":"mp3_44100_128"},"duration":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Duration"}},"type":"object","required":["prompt"],"title":"SoundGenerateRequest"},"app__api__unified__speech__TranscribeRequest":{"properties":{"audio_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Audio Url"},"audio_base64":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Audio Base64"},"language":{"type":"string","title":"Language","default":"en"}},"type":"object","title":"TranscribeRequest"},"InputFile":{"properties":{"name":{"type":"string","title":"Name","description":"Filename (e.g. 'data.csv')"},"content":{"type":"string","title":"Content","description":"Base64-encoded file content"}},"type":"object","required":["name","content"],"title":"InputFile","description":"A file to make available in the sandbox at /home/user/input/."},"SynthesizeRequest":{"properties":{"text":{"type":"string","title":"Text"},"voice_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voice Model"},"voice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voice Id"},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider","default":"auto"},"stability":{"type":"number","title":"Stability","default":0.5},"similarity_boost":{"type":"number","title":"Similarity Boost","default":0.75}},"type":"object","required":["text"],"title":"SynthesizeRequest"},"SiteIntelRequest":{"properties":{"domain":{"type":"string","title":"Domain"},"mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mode","default":"overview"}},"type":"object","required":["domain"],"title":"SiteIntelRequest"},"ImageGenerateRequest":{"properties":{"prompt":{"type":"string","title":"Prompt","description":"Describe a CONCRETE, grounded scene: real people, real objects, physical screens and devices, natural light, editorial photography quality (or a clean minimal illustration of the actual concept). Words like 'futuristic', 'holographic', 'glowing', or neon-tech scenery produce the same generic AI-cliche image every time; describe the present-day, physical version of the scene instead."},"aspect_ratio":{"type":"string","title":"Aspect Ratio","default":"1:1"},"image_size":{"type":"string","title":"Image Size","default":"512px"},"reference_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Image Url"},"skip_default_style":{"type":"boolean","title":"Skip Default Style","description":"Leave false (recommended). False applies the house visual style guidance (grounded realistic imagery, avoids overused AI-tech cliches). Set true ONLY when you are deliberately providing complete art direction of your own and want zero house styling.","default":false}},"type":"object","required":["prompt"],"title":"ImageGenerateRequest"},"ScreenshotRequest":{"properties":{"url":{"type":"string","title":"Url"},"width":{"type":"integer","title":"Width","default":1280},"height":{"type":"integer","title":"Height","default":720},"format":{"type":"string","enum":["png","jpg","webp"],"title":"Format","default":"png"},"full_page":{"type":"boolean","title":"Full Page","default":false}},"type":"object","required":["url"],"title":"ScreenshotRequest"},"app__api__unified__messages__SendMessageRequest":{"properties":{"to":{"type":"string","title":"To"},"channel":{"type":"string","enum":["auto","sms","whatsapp"],"title":"Channel","default":"auto"},"message":{"type":"string","title":"Message"},"from_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Number"}},"type":"object","required":["to","message"],"title":"SendMessageRequest"},"DomainsRequest":{"properties":{"mode":{"type":"string","title":"Mode","default":"suggest-names"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Id"},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purpose"},"search_options":{"anyOf":[{"$ref":"#/components/schemas/DomainSearchOptions"},{"type":"null"}]},"focus":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Focus"},"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"},"exact_extension":{"type":"boolean","title":"Exact Extension","default":false},"offset":{"type":"integer","title":"Offset","default":0},"tlds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tlds"},"domains":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Domains"}},"type":"object","title":"DomainsRequest"},"AgentRequest":{"properties":{"capability":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Capability","description":"Which capability to run, with its params."},"params":{"additionalProperties":true,"type":"object","title":"Params","description":"The named capability's parameters."},"request":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request","description":"What you need, in plain words, instead of capability and params: it is routed to the capability that serves it, its params are filled from the words, and it runs."}},"type":"object","title":"AgentRequest"},"FileConvertRequest":{"properties":{"file_url":{"type":"string","title":"File Url"},"source_format":{"type":"string","title":"Source Format"},"target_format":{"type":"string","title":"Target Format","default":"pdf"}},"type":"object","required":["file_url","source_format"],"title":"FileConvertRequest"},"SubtitleRequest":{"properties":{"audio_url":{"type":"string","title":"Audio Url"},"language":{"type":"string","title":"Language","default":"en"},"format":{"type":"string","title":"Format","default":"srt"}},"type":"object","required":["audio_url"],"title":"SubtitleRequest"},"BgRemoveRequest":{"properties":{"image_url":{"type":"string","title":"Image Url"},"size":{"type":"string","enum":["auto","small","hd"],"title":"Size","default":"auto"},"format":{"type":"string","enum":["png","webp","jpg"],"title":"Format","default":"png"}},"type":"object","required":["image_url"],"title":"BgRemoveRequest"},"app__api__unified__transcription__TranscribeRequest":{"properties":{"audio_url":{"type":"string","title":"Audio Url"},"language":{"type":"string","title":"Language","default":"en"},"speaker_labels":{"type":"boolean","title":"Speaker Labels","default":true}},"type":"object","required":["audio_url"],"title":"TranscribeRequest"},"SearchRequest":{"properties":{"query":{"type":"string","title":"Query"},"mode":{"type":"string","title":"Mode","default":"ai"},"num_results":{"type":"integer","title":"Num Results","default":10},"country":{"type":"string","title":"Country","default":"us"},"freshness":{"type":"string","title":"Freshness","default":"any"}},"type":"object","required":["query"],"title":"SearchRequest"},"DocumentExtractRequest":{"properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"URL to scrape and extract from"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content","description":"Pre-scraped content to extract from (alternative to url)"},"extraction_prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Extraction Prompt","description":"REQUIRED unless schema is provided. Natural language description of what to extract, e.g. 'Extract all product prices and features'"},"schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Schema","description":"REQUIRED unless extraction_prompt is provided. JSON schema defining the structure of data to extract"}},"type":"object","title":"DocumentExtractRequest"},"ScrapeRequest":{"properties":{"url":{"type":"string","title":"Url"},"mode":{"type":"string","title":"Mode","default":"standard"},"output":{"type":"string","title":"Output","default":"markdown"},"wait_for":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Wait For"},"timeout":{"type":"integer","title":"Timeout","default":30}},"type":"object","required":["url"],"title":"ScrapeRequest"},"EmailVerifyRequest":{"properties":{"email":{"type":"string","title":"Email"}},"type":"object","required":["email"],"title":"EmailVerifyRequest"},"UnifiedResponse":{"description":"Standard envelope for all unified API responses.","properties":{"success":{"title":"Success","type":"boolean"},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"null"}],"default":null,"title":"Data"},"error":{"anyOf":[{"$ref":"#/components/schemas/UnifiedError"},{"type":"null"}],"default":null},"metadata":{"$ref":"#/components/schemas/UnifiedMetadata"},"credits_used":{"default":0,"title":"Credits Used","type":"integer"}},"required":["success"],"title":"UnifiedResponse","type":"object"},"VideoDownloadRequest":{"properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"job_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Id"},"quality":{"type":"string","title":"Quality","default":"720"},"format":{"type":"string","title":"Format","default":"mp4"}},"type":"object","title":"VideoDownloadRequest"},"ProfileFindRequest":{"properties":{"linkedin_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Linkedin Url"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"include_image":{"type":"boolean","title":"Include Image","default":true}},"type":"object","title":"ProfileFindRequest"},"EmailFindRequest":{"properties":{"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"domain":{"type":"string","title":"Domain"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"}},"type":"object","required":["first_name","last_name","domain"],"title":"EmailFindRequest"},"UnifiedError":{"description":"RFC 7807 problem detail for machine-actionable errors.","properties":{"type":{"title":"Type","type":"string"},"title":{"title":"Title","type":"string"},"status":{"title":"Status","type":"integer"},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Detail"},"is_retriable":{"default":false,"title":"Is Retriable","type":"boolean"},"retry_after_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"title":"Retry After Seconds"},"alternative_action":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Alternative Action"},"error_category":{"default":"unknown","title":"Error Category","type":"string"},"caller_error":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Caller Error"}},"required":["type","title","status"],"title":"UnifiedError","type":"object"},"ResearchRequest":{"properties":{"query":{"type":"string","title":"Query"},"depth":{"type":"string","title":"Depth","default":"standard"},"enrich_entities":{"type":"boolean","title":"Enrich Entities","default":true},"include_analysis":{"type":"boolean","title":"Include Analysis","default":false},"synthesis":{"type":"boolean","title":"Synthesis","default":true},"output_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Output Schema"},"source_types":{"items":{"type":"string"},"type":"array","title":"Source Types","default":["web"]},"domain_whitelist":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Domain Whitelist"},"domain_blacklist":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Domain Blacklist"},"max_sources":{"type":"integer","title":"Max Sources","default":15},"freshness":{"type":"string","title":"Freshness","default":"any"}},"type":"object","required":["query"],"title":"ResearchRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"UnifiedMetadata":{"description":"Metadata included in every unified API response.","properties":{"provider_used":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Provider Used"},"providers_tried":{"items":{"type":"string"},"title":"Providers Tried","type":"array"},"mode_used":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Mode Used"},"response_time_ms":{"default":0,"title":"Response Time Ms","type":"integer"},"request_id":{"default":"","title":"Request Id","type":"string"},"capability":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Capability"},"params":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Params"}},"title":"UnifiedMetadata","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"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"DomainSearchOptions":{"properties":{"priorities":{"anyOf":[{"items":{"type":"string","enum":["total_length","annual_price","renewal_price","registration_total","semantic_fit","brandability","label_length"]},"type":"array"},{"type":"null"}],"title":"Priorities","description":"Ordering objectives, most important first: total_length (Shortest domain); annual_price (Cheapest first year); renewal_price (Cheapest to keep); registration_total (Lowest upfront); semantic_fit (Best fit); brandability (Brandable); label_length (Shortest name)"},"max_total_length":{"anyOf":[{"type":"integer","maximum":253.0,"minimum":1.0},{"type":"null"}],"title":"Max Total Length","description":"Longest complete domain, dots and extension included"},"max_label_length":{"anyOf":[{"type":"integer","maximum":63.0,"minimum":1.0},{"type":"null"}],"title":"Max Label Length","description":"Longest name before the dot"},"max_annual_price":{"anyOf":[{"type":"number","maximum":1000000.0,"minimum":0.0},{"type":"null"}],"title":"Max Annual Price","description":"Highest first-year price per year, in USD, at the cheaper registrar"},"max_renewal_price":{"anyOf":[{"type":"number","maximum":1000000.0,"minimum":0.0},{"type":"null"}],"title":"Max Renewal Price","description":"Highest yearly renewal price, in USD"},"max_registration_total":{"anyOf":[{"type":"number","maximum":1000000.0,"minimum":0.0},{"type":"null"}],"title":"Max Registration Total","description":"Highest amount charged at purchase, in USD"},"hacks":{"anyOf":[{"type":"string","enum":["include","exclude","only"]},{"type":"null"}],"title":"Hacks","description":"Domain hacks: include (Allowed); exclude (No hacks); only (Only hacks)"},"allow_premium":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Allow Premium","description":"Include registry premium names, which cost more than the standard price"}},"additionalProperties":false,"type":"object","title":"DomainSearchOptions","description":"Search options, one vocabulary shared with the app (apps/shared/data/domain-search-options.json). Send only the fields you set; null (or priorities []) leaves that field to the brief."}},"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"omk_ API key","description":"Your API key, sent as 'Authorization: Bearer omk_...'. The same key works across every product."}}},"externalDocs":{"url":"https://suprsonic.ai/docs/api"}}