{"openapi":"3.1.0","info":{"title":"Readymade API","version":"1","description":"Small paid APIs. Prepaid credit, priced per unit, refunded on failure."},"servers":[{"url":"https://readymadeapi.com"}],"security":[{"bearer":[]},{"apiKey":[]}],"paths":{"/v1/og-card":{"post":{"operationId":"og_card_render","tags":["OG Card Renderer"],"summary":"Render one social card from a title: five layouts, four sizes, PNG, JPEG or WebP, with your logo and colours.","description":"$0.002 per image. Social preview images (Open Graph, X, LinkedIn) from a title, in one call.","x-price":{"usd":"0.002","unit":"image","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OgCardRenderInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/business-days/add":{"post":{"operationId":"business_days_add","tags":["EU Business Days"],"summary":"Add or subtract business days from a date, skipping weekends and public holidays.","description":"$0.00016 per call. Business-day maths for 30 European countries: add working days, count them, check a date.","x-price":{"usd":"0.00016","unit":"call","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessDaysAddInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/business-days/between":{"post":{"operationId":"business_days_between","tags":["EU Business Days"],"summary":"Count business days from one date (included) to another (excluded).","description":"$0.00016 per call. Business-day maths for 30 European countries: add working days, count them, check a date.","x-price":{"usd":"0.00016","unit":"call","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessDaysBetweenInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/business-days/check":{"post":{"operationId":"business_days_check","tags":["EU Business Days"],"summary":"Is this date a business day? Returns the holiday name when it isn't.","description":"$0.00016 per call. Business-day maths for 30 European countries: add working days, count them, check a date.","x-price":{"usd":"0.00016","unit":"call","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessDaysCheckInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/localise":{"post":{"operationId":"localiser_localise","tags":["Placeholder-Safe Localiser"],"summary":"Translate an i18next JSON, ARB, iOS .strings, Android strings.xml, Rails YAML, XLIFF 2 or gettext PO file into up to 10 languages, with a validation report.","description":"$0.0006 per string × language. Translate app string files and get the same files back with every placeholder, tag and plural form intact.","x-price":{"usd":"0.0006","unit":"string × language","max_units":400},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocaliserLocaliseInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/transcript/transcribe":{"post":{"operationId":"transcript_intel_transcribe","tags":["Transcript Intelligence"],"summary":"Queue a transcription. max_minutes is the most the audio may last; you are charged only for the seconds it actually runs.","description":"$0.000132 per second. Audio or video in, timestamped transcript out as JSON, SRT and VTT. Up to 3 hours per file.","x-price":{"usd":"0.000132","unit":"second","max_units":10800},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscriptIntelTranscribeInput"}}}},"responses":{"202":{"description":"Queued and charged in advance; what doesn't run is refunded. Poll status_url","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAccepted"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/transcript/instant":{"post":{"operationId":"transcript_intel_transcribe_now","tags":["Transcript Intelligence"],"summary":"Transcribe a short clip, up to 5 minutes and 15 MB, and get text, timestamps, SRT and VTT in the same call. max_seconds is the most the clip may last; you are charged only for the seconds it actually runs.","description":"$0.000132 per second. Audio or video in, timestamped transcript out as JSON, SRT and VTT. Up to 3 hours per file.","x-price":{"usd":"0.000132","unit":"second","max_units":300},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscriptIntelTranscribeNowInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/subtitles/subtitle":{"post":{"operationId":"subtitle_studio_subtitle","tags":["Subtitle Studio"],"summary":"Queue subtitles. max_minutes is the most the audio may last; you are charged only for the seconds it actually runs.","description":"$0.0002 per second. Audio or video in, subtitles that follow reading-speed rules out, as SRT, VTT and ASS.","x-price":{"usd":"0.0002","unit":"second","max_units":10800},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitleStudioSubtitleInput"}}}},"responses":{"202":{"description":"Queued and charged in advance; what doesn't run is refunded. Poll status_url","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAccepted"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/listing-photo/check":{"post":{"operationId":"listing_photo_check_check","tags":["Listing Photo Check"],"summary":"Check one photo: size, white background, how much of the frame the product fills, one product, no text added around it, sharpness.","description":"$0.003 per image. Checks a product photo against a marketplace's image rules, rule by rule, with what it measured.","x-price":{"usd":"0.003","unit":"image","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingPhotoCheckCheckInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/voiceover/speak":{"post":{"operationId":"tts_pro_speak","tags":["VoiceOver TTS"],"summary":"Queue speech for a text. Charged per 100 characters spoken, rounded up; pauses are free.","description":"$0.00012 per 100 characters. Text in, natural English speech out as MP3, with word timings. Up to 20,000 characters per call.","x-price":{"usd":"0.00012","unit":"100 characters","max_units":200},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TtsProSpeakInput"}}}},"responses":{"202":{"description":"Queued and charged in advance; what doesn't run is refunded. Poll status_url","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAccepted"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/voiceover/instant":{"post":{"operationId":"tts_pro_speak_now","tags":["VoiceOver TTS"],"summary":"Speak up to 2,000 characters and get the MP3 and word timings in the same call, usually within a second.","description":"$0.00012 per 100 characters. Text in, natural English speech out as MP3, with word timings. Up to 20,000 characters per call.","x-price":{"usd":"0.00012","unit":"100 characters","max_units":20},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TtsProSpeakNowInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/cutout/print":{"post":{"operationId":"print_cutout_cut","tags":["Print-Ready Cutout"],"summary":"Queue a cutout. Charged per image, and refunded if it fails.","description":"$0.02 per image. Design or photo in, transparent 300 DPI PNG out, with optional bleed and white sticker border.","x-price":{"usd":"0.02","unit":"image","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintCutoutCutInput"}}}},"responses":{"202":{"description":"Queued and charged in advance; what doesn't run is refunded. Poll status_url","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAccepted"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/cutout/instant":{"post":{"operationId":"print_cutout_cut_now","tags":["Print-Ready Cutout"],"summary":"Cut out one image and get the result in the same call, usually within a second. Images up to 16 megapixels.","description":"$0.02 per image. Design or photo in, transparent 300 DPI PNG out, with optional bleed and white sticker border.","x-price":{"usd":"0.02","unit":"image","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintCutoutCutNowInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/upscale/image":{"post":{"operationId":"upscale_restore_upscale","tags":["Upscale & Restore"],"summary":"Queue an upscale. Charged per image, and refunded if it fails.","description":"$0.0048 per large image. Image in, 2× or 4× upscaled image out, or sized to a paper format at 300 DPI.","x-price":{"usd":"0.0048","unit":"large image","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpscaleRestoreUpscaleInput"}}}},"responses":{"202":{"description":"Queued and charged in advance; what doesn't run is refunded. Poll status_url","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAccepted"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/upscale/instant":{"post":{"operationId":"upscale_restore_upscale_now","tags":["Upscale & Restore"],"summary":"Upscale one image 2x or 4x and get the result in the same call, in a few seconds. Images up to 1024 by 1024 pixels.","description":"$0.0016 per image. Image in, 2× or 4× upscaled image out, or sized to a paper format at 300 DPI.","x-price":{"usd":"0.0016","unit":"image","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpscaleRestoreUpscaleNowInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/web-reader":{"post":{"operationId":"web_reader_read","tags":["Agent Web Reader"],"summary":"Fetch one public page and return its title and main content as Markdown.","description":"$0.00064 per page. Any public web page as clean Markdown, with the menus, ads and footers taken out.","x-price":{"usd":"0.00064","unit":"page","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebReaderReadInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/qr":{"post":{"operationId":"qr_barcode_qr","tags":["QR & Barcode"],"summary":"Encode text or a URL as a QR code. PNG by default, SVG with format=svg.","description":"$0.0005 per code. Make QR codes and barcodes as PNG or SVG, and read them back from any photo.","x-price":{"usd":"0.0005","unit":"code","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QrBarcodeQrInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/barcode":{"post":{"operationId":"qr_barcode_barcode","tags":["QR & Barcode"],"summary":"Encode a Code 128, Code 39, EAN-13 or EAN-8 barcode. PNG by default, SVG with format=svg.","description":"$0.0005 per code. Make QR codes and barcodes as PNG or SVG, and read them back from any photo.","x-price":{"usd":"0.0005","unit":"code","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QrBarcodeBarcodeInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/codes/read":{"post":{"operationId":"qr_barcode_read","tags":["QR & Barcode"],"summary":"Find and decode every QR code and barcode in an image: QR, Data Matrix, Aztec, PDF417, EAN, UPC, Code 128, Code 39, ITF and more. Nothing found, nothing charged.","description":"$0.001 per image. Make QR codes and barcodes as PNG or SVG, and read them back from any photo.","x-price":{"usd":"0.001","unit":"image","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QrBarcodeReadInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/image/optimize":{"post":{"operationId":"image_optimizer_optimize","tags":["Image Optimizer"],"summary":"Convert and compress one image, optionally fitting it inside a maximum width and height.","description":"$0.001 per image. Convert, resize and compress an image to WebP, JPEG or PNG.","x-price":{"usd":"0.001","unit":"image","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageOptimizerOptimizeInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/pdf/invoice":{"post":{"operationId":"pdf_forge_invoice","tags":["PDF Forge"],"summary":"Render an invoice or receipt. Line totals, tax and the grand total are worked out for you.","description":"$0.003 per document. Invoices and reports as well-set PDFs from plain JSON.","x-price":{"usd":"0.003","unit":"document","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfForgeInvoiceInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/pdf/report":{"post":{"operationId":"pdf_forge_report","tags":["PDF Forge"],"summary":"Render a titled document with sections, paragraphs and tables.","description":"$0.003 per document. Invoices and reports as well-set PDFs from plain JSON.","x-price":{"usd":"0.003","unit":"document","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfForgeReportInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/link-preview":{"post":{"operationId":"link_preview_preview","tags":["Link Preview"],"summary":"Fetch one public page and return its Open Graph, Twitter Card and HTML metadata as one tidy object.","description":"$0.001 per link. The title, description, image and icon of any public web page, ready to show as a link card.","x-price":{"usd":"0.001","unit":"link","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkPreviewPreviewInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/web-extract":{"post":{"operationId":"web_extract_extract","tags":["Web Extract"],"summary":"Read one public page, or content you send, and fill your JSON Schema from it. The output is checked against the schema; if it does not validate, nothing is charged.","description":"$0.012 per page. Send a URL and a JSON Schema, get the page's data as JSON that matches it. You pay only when it validates.","x-price":{"usd":"0.012","unit":"page","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebExtractExtractInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/iban/check":{"post":{"operationId":"iban_vat_iban","tags":["IBAN & VAT Number Check"],"summary":"Is this IBAN well formed? Checks the country, its length and the mod-97 check digits, and returns it tidied.","description":"$0.00016 per check. Check an IBAN or an EU VAT number offline: structure, country rules and check digits.","x-price":{"usd":"0.00016","unit":"check","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IbanVatIbanInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/vat/check":{"post":{"operationId":"iban_vat_vat","tags":["IBAN & VAT Number Check"],"summary":"Is this EU VAT number well formed? Checks the country's format and, for 20 countries, its check digit. Does not look it up in VIES.","description":"$0.00016 per check. Check an IBAN or an EU VAT number offline: structure, country rules and check digits.","x-price":{"usd":"0.00016","unit":"check","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IbanVatVatInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/chart":{"post":{"operationId":"chart_renderer_render","tags":["Chart Renderer"],"summary":"Render one chart as PNG or SVG from JSON: column, bar, line, area, scatter, donut, pie, share, stat, sparkline, meter, heatmap or funnel.","description":"$0.002 per chart. Turn numbers into a finished chart image with one call: 13 chart types, 6 themes, 6 gradient backdrops.","x-price":{"usd":"0.002","unit":"chart","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartRendererRenderInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/phone/check":{"post":{"operationId":"phone_check_check","tags":["Phone Number Check"],"summary":"Parse a phone number as typed and say whether it is valid for its country, what kind of line it is, and how to write it in E.164, international and national form.","description":"$0.00016 per check. Check and tidy a phone number from any country, offline: valid or not, its type, and the standard ways to write it.","x-price":{"usd":"0.00016","unit":"check","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneCheckCheckInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/fx/rates":{"post":{"operationId":"fx_rates_rates","tags":["EU Exchange Rates"],"summary":"Reference rates for a day, against any base currency. Weekends and holidays answer with the last published day.","description":"$0.00016 per call. The ECB's daily euro reference rates for 30 currencies, with any base currency, conversion and the last 90 days.","x-price":{"usd":"0.00016","unit":"call","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxRatesRatesInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/fx/convert":{"post":{"operationId":"fx_rates_convert","tags":["EU Exchange Rates"],"summary":"Convert an amount between two currencies at the reference rate of a day.","description":"$0.00016 per call. The ECB's daily euro reference rates for 30 currencies, with any base currency, conversion and the last 90 days.","x-price":{"usd":"0.00016","unit":"call","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxRatesConvertInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/sheets/read":{"post":{"operationId":"sheet_convert_read","tags":["Spreadsheet Convert"],"summary":"Turn an XLSX, XLS, ODS, CSV or TSV file into JSON: every sheet, or the one you name, as rows of objects keyed by the header row or as plain arrays.","description":"$0.00064 per file. Read Excel, OpenDocument and CSV files as JSON, and write JSON back out as an Excel file.","x-price":{"usd":"0.00064","unit":"file","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SheetConvertReadInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/sheets/write":{"post":{"operationId":"sheet_convert_write","tags":["Spreadsheet Convert"],"summary":"Turn JSON rows into an Excel file with one sheet per table: a bold header row, real numbers, columns sized to their content.","description":"$0.00064 per file. Read Excel, OpenDocument and CSV files as JSON, and write JSON back out as an Excel file.","x-price":{"usd":"0.00064","unit":"file","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SheetConvertWriteInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/markdown/from-file":{"post":{"operationId":"file_to_markdown_convert","tags":["File to Markdown"],"summary":"Send a DOCX, PPTX, XLSX, PDF, EPUB, HTML or CSV file by link or as base64 and get its text back as Markdown, with headings, lists, tables and links kept.","description":"$0.003 per file. Turn Word, PowerPoint, Excel, PDF, EPUB, HTML and CSV files into clean Markdown that people and language models can read.","x-price":{"usd":"0.003","unit":"file","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileToMarkdownConvertInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/seo/audit":{"post":{"operationId":"seo_audit_audit","tags":["On-page SEO Audit"],"summary":"Fetch one public page and report its title, description, headings, canonical address, indexing rules, language, images without alt text, links, social tags and structured data, with issues ranked by severity and a score out of 100.","description":"$0.0012 per page. Check one web page for the on-page basics search engines and link previews rely on, with a score and a list of what to fix.","x-price":{"usd":"0.0012","unit":"page","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeoAuditAuditInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/email/check":{"post":{"operationId":"email_check_check","tags":["Email Check"],"summary":"Check one address: is it well formed, does its domain take mail, is it a disposable, free or role address, and did the sender probably mistype a common domain.","description":"$0.0005 per address. Check an email address before you store or mail it: syntax, the domain's mail servers, throwaway and role addresses, and likely typos.","x-price":{"usd":"0.0005","unit":"address","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailCheckCheckInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/audio/clean":{"post":{"operationId":"audio_cleanup_clean","tags":["Audio Clean-up"],"summary":"Queue a clean-up. max_minutes is the most the audio may last; you are charged only for the seconds it actually runs.","description":"$0.00005 per second. Remove noise, music and room echo from a voice recording and get the clean voice back as MP3. Up to 60 minutes per file.","x-price":{"usd":"0.00005","unit":"second","max_units":3600},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudioCleanupCleanInput"}}}},"responses":{"202":{"description":"Queued and charged in advance; what doesn't run is refunded. Poll status_url","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAccepted"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/pii/redact":{"post":{"operationId":"pii_redact_redact","tags":["PII Redact"],"summary":"Send text and get it back with personal data masked, plus where each piece was found and how sure the model is.","description":"$0.001 per 1k characters. Find and mask personal data in text: names, emails, phone numbers, addresses, IBANs, card and ID numbers, in many languages.","x-price":{"usd":"0.001","unit":"1k characters","max_units":100},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PiiRedactRedactInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/text/ai-score":{"post":{"operationId":"ai_text_score_score","tags":["AI-written Text Score"],"summary":"Score one English text: 0 for untouched human writing, around 0.3 for a human draft a chatbot polished, 1 for text a model wrote from scratch.","description":"$0.00024 per text. Estimate how much of an English text was written by a language model, as a score from 0 to 1 with a plain band.","x-price":{"usd":"0.00024","unit":"text","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiTextScoreScoreInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/documents/read":{"post":{"operationId":"document_reader_read","tags":["Document Reader"],"summary":"Read one page from an image or PDF. mode=text returns the text, mode=table returns the table as HTML, mode=fields fills in the JSON fields you list.","description":"$0.0028 per page. Read a scan, photo or PDF page: as plain text, as a table, or straight into the fields you name, such as an invoice's number, date and total.","x-price":{"usd":"0.0028","unit":"page","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentReaderReadInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/invoices/parse":{"post":{"operationId":"invoice_parser_parse","tags":["Invoice Parser"],"summary":"Send an invoice and get its number, dates, seller, buyer, line items, subtotal, tax, total, currency and IBAN as JSON. Each page read is one unit.","description":"$0.01 per page. Read an invoice from a scan, photo or PDF into clean JSON: number, dates, seller, buyer, every line item, subtotal, tax and total.","x-price":{"usd":"0.01","unit":"page","max_units":3},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceParserParseInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/receipts/parse":{"post":{"operationId":"receipt_parser_parse","tags":["Receipt Parser"],"summary":"Send a receipt and get the merchant, date, time, items, subtotal, tax, total, currency and payment method as JSON. Each page read is one unit.","description":"$0.008 per page. Read a shop or restaurant receipt from a photo or scan into JSON: merchant, date, items, tax, total and how it was paid.","x-price":{"usd":"0.008","unit":"page","max_units":2},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptParserParseInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/resumes/parse":{"post":{"operationId":"resume_parser_parse","tags":["Resume Parser"],"summary":"Send a résumé and get the name, contact details, summary, each job and each degree, skills and languages as JSON. Each page read is one unit.","description":"$0.016 per page. Read a CV or résumé from a PDF or image into JSON: contact details, experience, education, skills and languages.","x-price":{"usd":"0.016","unit":"page","max_units":3},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResumeParserParseInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/images/nsfw-check":{"post":{"operationId":"nsfw_check_check","tags":["NSFW Image Check"],"summary":"Check one image for sexual content. Returns a score from 0 to 1 and whether it passes your threshold.","description":"$0.0004 per image. Tell whether an image shows sexual content, as a score from 0 to 1 and a yes or no, before you publish a user's upload.","x-price":{"usd":"0.0004","unit":"image","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NsfwCheckCheckInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/text/classify":{"post":{"operationId":"text_classify_classify","tags":["Text Classify"],"summary":"Ask up to ten questions about one text, each with your own labels, and get the chosen label and a score for each.","description":"$0.0005 per text. Sort any text into the labels you choose: route a support ticket, tag a review, score sentiment or urgency, in many languages and in milliseconds.","x-price":{"usd":"0.0005","unit":"text","max_units":1},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextClassifyClassifyInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/text/entities":{"post":{"operationId":"entity_extract_extract","tags":["Entity Extract"],"summary":"Send text and the kinds of thing to look for, in your own words, and get each one found with its position and a score.","description":"$0.001 per 1k characters. Pull out the things you name from any text: order numbers, products, people, places, dates, or whatever your own kinds are, in many languages.","x-price":{"usd":"0.001","unit":"1k characters","max_units":100},"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityExtractExtractInput"}}}},"responses":{"200":{"description":"Done","headers":{"X-Request-Id":{"schema":{"type":"string"}},"X-Units":{"schema":{"type":"integer"}},"X-Charged-Usd":{"schema":{"type":"string","description":"Plain decimal USD, e.g. 0.002"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"401":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"Not enough credit; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"key_budget_too_small: the call costs more than the key's whole daily budget; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"The same Idempotency-Key is still running; retry after Retry-After seconds","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Request body over 2 MiB; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"Idempotency-Key reused with a different body","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"budget_spent: the key's daily budget is used up (Retry-After: until midnight UTC); too_many_in_flight: over 2 calls at once per key across engine-backed APIs; site_busy: the site a URL points at is being asked too often, retry after Retry-After seconds; too_many_bad_keys: 30 requests with a missing or invalid key from one address in a minute, wait out Retry-After; nothing charged","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"500":{"description":"Our fault; charge refunded. Quote X-Request-Id","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"engine_busy or unavailable: the engine is at capacity or a service is away, retry after Retry-After seconds; not_configured: this deployment lacks a service the op needs, no Retry-After; upstream_failed, upstream_timeout or timeout: a model or site behind the API failed or took too long. Not charged, or the charge is refunded","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/jobs/{id}":{"get":{"operationId":"get_job","summary":"Status of a job, with its result once finished. Free; results are kept for 7 days.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The job"},"404":{"description":"No such job on this account","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/jobs/{id}/result":{"get":{"operationId":"get_job_result","summary":"The result of a finished job.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The result"},"404":{"description":"No such job on this account","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"job_not_finished, or job_failed (refunded)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"410":{"description":"result_expired: results are kept for 7 days","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}}},"components":{"schemas":{"Problem":{"type":"object","required":["type","title","status"],"properties":{"type":{"type":"string","format":"uri"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"}}},"OgCardRenderInput":{"required":["title"],"additionalProperties":false,"type":"object","properties":{"title":{"description":"Main headline, 1–140 characters. Wrapped and sized to fit. All text fields take Latin\nand Cyrillic script; emoji and other scripts are refused (400) before any charge.","type":"string"},"subtitle":{"description":"Optional second line, up to 200 characters.","type":["string","null"],"default":null},"eyebrow":{"description":"Small label above the title, such as your site or section name.","type":["string","null"],"default":null},"footer":{"description":"Footer text, usually your domain.","type":["string","null"],"default":null},"theme":{"description":"Card colours: `dark` (the default) or `light`.","type":"string","enum":["dark","light"]},"accent":{"description":"Accent colour as #RRGGBB.","type":["string","null"],"default":null},"layout":{"description":"`standard` (the default), `blog`, `product`, `docs` or `plain`.","oneOf":[{"description":"The title on the left, a dot pattern on the right.","type":"string","const":"standard"},{"description":"For articles: an accent bar on the left and a byline with avatar, author, date and\nreading time.","type":"string","const":"blog"},{"description":"For products: the text beside a panel in the accent colour that holds your logo.","type":"string","const":"product"},{"description":"For documentation: a fine grid and a frame behind the text.","type":"string","const":"docs"},{"description":"The text alone, centred vertically.","type":"string","const":"plain"}]},"size":{"description":"`og` 1200×630 (the default), `x` 1200×675, `linkedin` 1200×627 or `square` 1080×1080.","oneOf":[{"description":"1200 × 630: Open Graph, Facebook, Slack, iMessage, Discord.","type":"string","const":"og"},{"description":"1200 × 675: X (Twitter) large image cards.","type":"string","const":"x"},{"description":"1200 × 627: LinkedIn link shares.","type":"string","const":"linkedin"},{"description":"1080 × 1080: square posts.","type":"string","const":"square"}]},"format":{"description":"`png` (the default), `jpeg` or `webp`.","oneOf":[{"type":"string","enum":["png"]},{"description":"Quality 90, the smallest file.","type":"string","const":"jpeg"},{"description":"Lossless.","type":"string","const":"webp"}]},"author":{"description":"Author name, up to 60 characters: the byline in the blog layout, the footer line in the\nothers.","type":["string","null"],"default":null},"date":{"description":"Date as you want it shown, such as \"21 Nov 2026\", up to 30 characters.","type":["string","null"],"default":null},"reading_time":{"description":"Reading time as you want it shown, such as \"6 min read\", up to 20 characters.","type":["string","null"],"default":null},"logo_base64":{"description":"Your logo, base64 (PNG, JPEG or WebP; up to 512 KB and 4096 px a side). It travels in the\nrequest; no link is ever fetched.","type":["string","null"],"default":null},"avatar_base64":{"description":"The author's photo, base64 (PNG, JPEG or WebP; up to 512 KB), cropped to a circle. Blog\nlayout only.","type":["string","null"],"default":null},"background":{"description":"Background colour as #RRGGBB, in place of the theme's.","type":["string","null"],"default":null},"background_to":{"description":"A second colour as #RRGGBB: the background becomes a diagonal gradient from\n`background` to this one.","type":["string","null"],"default":null},"text_color":{"description":"Text colour as #RRGGBB. Unset with a `background`, dark or light text is chosen to suit\nit. Colours too close to read (contrast under 3:1) are refused before any charge.","type":["string","null"],"default":null}}},"BusinessDaysAddInput":{"required":["country","date","days"],"additionalProperties":false,"type":"object","properties":{"country":{"description":"ISO 3166-1 alpha-2 code, e.g. \"RO\", \"DE\".","type":"string"},"date":{"description":"Start date, YYYY-MM-DD.","type":"string"},"days":{"description":"Business days to add; negative to go back. Between -2000 and 2000.","type":"integer","format":"int64"}}},"BusinessDaysBetweenInput":{"required":["country","from","to"],"additionalProperties":false,"type":"object","properties":{"country":{"description":"ISO 3166-1 alpha-2 code, e.g. \"RO\", \"DE\".","type":"string"},"from":{"description":"First date, counted. YYYY-MM-DD.","type":"string"},"to":{"description":"End date, not counted. YYYY-MM-DD.","type":"string"}}},"BusinessDaysCheckInput":{"required":["country","date"],"additionalProperties":false,"type":"object","properties":{"country":{"description":"ISO 3166-1 alpha-2 code, e.g. \"RO\", \"DE\".","type":"string"},"date":{"description":"YYYY-MM-DD.","type":"string"}}},"LocaliserLocaliseInput":{"required":["format","content","targets"],"additionalProperties":false,"type":"object","properties":{"format":{"description":"Format of `content`; the translated files come back in the same format.","type":"string","enum":["i18next-json","arb","ios-strings","android-xml","rails-yaml","xliff2","po"]},"content":{"description":"The source file as UTF-8 text, at most 512 KB.","type":"string"},"source":{"description":"Source language as a BCP 47 tag.","type":"string","default":"en"},"targets":{"description":"Target languages as BCP 47 tags, 1 to 10, e.g. [\"ro\", \"pl\", \"de\"].","type":"array","items":{"type":"string"}},"tone":{"description":"Register of the translation.","type":["string","null"],"enum":["formal","informal",null]},"context":{"description":"Optional hints: what the product is, and character limits per key.","type":"object","properties":{"app":{"description":"What the product is, e.g. \"habit tracker for runners\".","type":["string","null"],"default":null},"max_length":{"description":"Character limits by key pattern, e.g. {\"button.*\": 18}.","type":"object","additionalProperties":{"type":"integer","format":"uint","minimum":0},"default":{}}},"additionalProperties":false}}},"TranscriptIntelTranscribeInput":{"required":["max_minutes"],"additionalProperties":false,"type":"object","properties":{"audio_url":{"description":"Direct https link to an audio or video file (up to 350 MB). Not a YouTube or TikTok page.","type":["string","null"],"default":null},"audio_base64":{"description":"The file itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"max_minutes":{"description":"The most the audio can last. This much is held; only the seconds it measures are\ncharged. Longer audio is refused and refunded.","type":"integer","format":"uint64","minimum":0},"language":{"description":"Language code such as \"en\" or \"ro\"; detected when left out.","type":["string","null"],"default":null},"speakers":{"description":"Label who said each segment (S1, S2, ...). Slower; same price.","type":"boolean","default":false},"callback_url":{"description":"Told the job's id and status when it ends, signed with your webhook secret.","type":["string","null"],"default":null}}},"TranscriptIntelTranscribeNowInput":{"additionalProperties":false,"properties":{"audio_url":{"description":"Direct https link to an audio or video file, up to 15 MB. Not a YouTube or TikTok page.","type":["string","null"],"default":null},"audio_base64":{"description":"The file itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"max_seconds":{"description":"The most the clip can last, 1 to 300, 120 if left out. This much is held; only the\nseconds it measures are charged. A longer clip is refused and not charged.","type":"integer","format":"uint64","minimum":0,"default":120},"language":{"description":"Language code such as \"en\" or \"ro\"; detected when left out.","type":["string","null"],"default":null}},"type":"object"},"SubtitleStudioSubtitleInput":{"required":["max_minutes"],"additionalProperties":false,"type":"object","properties":{"audio_url":{"description":"Direct https link to an audio or video file (up to 350 MB). Not a YouTube or TikTok page.","type":["string","null"],"default":null},"audio_base64":{"description":"The file itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"max_minutes":{"description":"The most the audio can last. This much is held; only the seconds it measures are\ncharged. Longer audio is refused and refunded.","type":"integer","format":"uint64","minimum":0},"language":{"description":"Language code such as \"en\" or \"ro\"; detected when left out.","type":["string","null"],"default":null},"speakers":{"description":"Label who said each segment (S1, S2, ...). Slower; same price.","type":"boolean","default":false},"callback_url":{"description":"Told the job's id and status when it ends, signed with your webhook secret.","type":["string","null"],"default":null}}},"ListingPhotoCheckCheckInput":{"required":["marketplace"],"additionalProperties":false,"type":"object","properties":{"image_url":{"description":"Direct link to a PNG, JPEG or WebP, up to 15 MB.","type":["string","null"],"default":null},"image_base64":{"description":"The image itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"marketplace":{"oneOf":[{"type":"string","enum":["ebay"]},{"description":"Amazon's rules for a main image.","type":"string","const":"amazon-main"},{"description":"eMAG's main image standard: the product fills about 85% of the frame.","type":"string","const":"emag-main"},{"description":"Etsy's first photo: at least 635 px on both sides, landscape or square.","type":"string","const":"etsy-first"}]}}},"TtsProSpeakInput":{"required":["text"],"additionalProperties":false,"type":"object","properties":{"text":{"description":"English text. `<break time=\"500ms\"/>` or `<break time=\"1.5s\"/>` adds a pause, up to 5 s.","type":"string"},"voice":{"description":"`af`/`am` are American, `bf`/`bm` British; `f` and `m` are the voice's pitch.","type":"string","enum":["af_heart","af_bella","af_nicole","am_michael","am_fenrir","am_puck","bf_emma","bf_isabella","bm_george","bm_fable"],"default":"af_heart"},"speed":{"description":"0.5 to 2. Normal speed is 1.","type":["number","null"],"format":"double","default":null},"say_as":{"description":"Whole words to say differently, as {\"SQL\": \"sequel\"}. At most 100. Word timings show\nthe replacement, and its characters are the ones charged.","type":"object","additionalProperties":{"type":"string"},"default":{}},"callback_url":{"description":"Told the job's id and status when it ends, signed with your webhook secret.","type":["string","null"],"default":null}}},"TtsProSpeakNowInput":{"required":["text"],"additionalProperties":false,"type":"object","properties":{"text":{"description":"English text. `<break time=\"500ms\"/>` or `<break time=\"1.5s\"/>` adds a pause, up to 5 s.","type":"string"},"voice":{"description":"`af`/`am` are American, `bf`/`bm` British; `f` and `m` are the voice's pitch.","type":"string","enum":["af_heart","af_bella","af_nicole","am_michael","am_fenrir","am_puck","bf_emma","bf_isabella","bm_george","bm_fable"],"default":"af_heart"},"speed":{"description":"0.5 to 2. Normal speed is 1.","type":["number","null"],"format":"double","default":null},"say_as":{"description":"Whole words to say differently, as {\"SQL\": \"sequel\"}. At most 100. Word timings show\nthe replacement, and its characters are the ones charged.","type":"object","additionalProperties":{"type":"string"},"default":{}},"callback_url":{"description":"Told the job's id and status when it ends, signed with your webhook secret.","type":["string","null"],"default":null}}},"PrintCutoutCutInput":{"additionalProperties":false,"properties":{"image_url":{"description":"Direct https link to a PNG, JPEG or WebP, up to 40 MB.","type":["string","null"],"default":null},"image_base64":{"description":"The file itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"dpi":{"description":"Written into the PNG, and used to turn millimetres into pixels. 72 to 600.","type":"integer","format":"uint32","minimum":0,"default":300},"bleed_mm":{"description":"Transparent margin added on every side, up to 10 mm.","type":"number","format":"double","default":0.0},"border_mm":{"description":"White sticker border around the cutout, up to 10 mm.","type":"number","format":"double","default":0.0},"callback_url":{"description":"Told the job's id and status when it ends, signed with your webhook secret.","type":["string","null"],"default":null}},"type":"object"},"PrintCutoutCutNowInput":{"additionalProperties":false,"properties":{"image_url":{"description":"Direct https link to a PNG, JPEG or WebP, up to 40 MB.","type":["string","null"],"default":null},"image_base64":{"description":"The file itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"dpi":{"description":"Written into the PNG, and used to turn millimetres into pixels. 72 to 600.","type":"integer","format":"uint32","minimum":0,"default":300},"bleed_mm":{"description":"Transparent margin added on every side, up to 10 mm.","type":"number","format":"double","default":0.0},"border_mm":{"description":"White sticker border around the cutout, up to 10 mm.","type":"number","format":"double","default":0.0},"callback_url":{"description":"Told the job's id and status when it ends, signed with your webhook secret.","type":["string","null"],"default":null}},"type":"object"},"UpscaleRestoreUpscaleInput":{"additionalProperties":false,"properties":{"image_url":{"description":"Direct https link to a PNG, JPEG or WebP, up to 40 MB and 4 megapixels.","type":["string","null"],"default":null},"image_base64":{"description":"The file itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"scale":{"description":"2 or 4. Leave out when you set `paper`.","type":["integer","null"],"format":"uint8","minimum":0,"maximum":255,"default":null},"paper":{"description":"Fit inside this paper size at 300 DPI, in the image's own orientation. Refused if that\nwould take more than 4×.","type":["string","null"],"enum":["a6","a5","a4","a3",null],"default":null},"callback_url":{"description":"Told the job's id and status when it ends, signed with your webhook secret.","type":["string","null"],"default":null}},"type":"object"},"UpscaleRestoreUpscaleNowInput":{"additionalProperties":false,"properties":{"image_url":{"description":"Direct https link to a PNG, JPEG or WebP, up to 40 MB and 4 megapixels.","type":["string","null"],"default":null},"image_base64":{"description":"The file itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"scale":{"description":"2 or 4. Leave out when you set `paper`.","type":["integer","null"],"format":"uint8","minimum":0,"maximum":255,"default":null},"paper":{"description":"Fit inside this paper size at 300 DPI, in the image's own orientation. Refused if that\nwould take more than 4×.","type":["string","null"],"enum":["a6","a5","a4","a3",null],"default":null},"callback_url":{"description":"Told the job's id and status when it ends, signed with your webhook secret.","type":["string","null"],"default":null}},"type":"object"},"WebReaderReadInput":{"required":["url"],"additionalProperties":false,"type":"object","properties":{"url":{"description":"A public http or https URL. Up to 3 MB of HTML or plain text.","type":"string"}}},"QrBarcodeQrInput":{"required":["data"],"additionalProperties":false,"type":"object","properties":{"data":{"description":"Text or URL, up to 2,000 bytes.","type":"string"},"format":{"type":"string","enum":["png","svg"]},"size":{"description":"Width and height in pixels, 64 to 4096. The code snaps down to whole pixels per module, and\ndense data needs a size of at least one pixel per module.","type":"integer","format":"uint32","minimum":0,"default":512},"correction":{"description":"Error correction: L, M, Q or H.","type":"string","enum":["L","M","Q","H"]}}},"QrBarcodeBarcodeInput":{"required":["data","symbology"],"additionalProperties":false,"type":"object","properties":{"data":{"type":"string"},"symbology":{"type":"string","enum":["code128","code39","ean13","ean8"]},"format":{"type":"string","enum":["png","svg"]},"module":{"description":"Width of the narrowest bar in pixels, 1 to 10.","type":"integer","format":"uint32","minimum":0,"default":3},"height":{"description":"Bar height in pixels, 20 to 1000.","type":"integer","format":"uint32","minimum":0,"default":120}}},"QrBarcodeReadInput":{"additionalProperties":false,"properties":{"image_url":{"description":"Direct link to a PNG, JPEG or WebP, up to 15 MB.","type":["string","null"],"default":null},"image_base64":{"description":"The image itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null}},"type":"object"},"ImageOptimizerOptimizeInput":{"required":["format"],"additionalProperties":false,"type":"object","properties":{"image_url":{"description":"Direct link to a PNG, JPEG or WebP, up to 15 MB.","type":["string","null"],"default":null},"image_base64":{"description":"The image itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"format":{"type":"string","enum":["webp","jpeg","png"]},"quality":{"description":"1 to 100. Ignored for PNG, which is lossless.","type":"integer","format":"uint8","minimum":0,"maximum":255,"default":80},"max_width":{"type":["integer","null"],"format":"uint32","minimum":0,"default":null},"max_height":{"type":["integer","null"],"format":"uint32","minimum":0,"default":null}}},"PdfForgeInvoiceInput":{"required":["number","date","currency","seller","buyer","items"],"additionalProperties":false,"type":"object","properties":{"title":{"description":"Heading, for example \"Invoice\", \"Receipt\" or \"Factură\".","type":"string","default":"Invoice"},"number":{"type":"string"},"date":{"type":"string"},"due_date":{"type":["string","null"],"default":null},"currency":{"type":"string"},"seller":{"type":"object","properties":{"name":{"type":"string"},"address":{"description":"Line breaks are kept.","type":"string"},"tax_id":{"type":["string","null"],"default":null}},"additionalProperties":false,"required":["name","address"]},"buyer":{"type":"object","properties":{"name":{"type":"string"},"address":{"description":"Line breaks are kept.","type":"string"},"tax_id":{"type":["string","null"],"default":null}},"additionalProperties":false,"required":["name","address"]},"items":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"quantity":{"description":"Decimal string such as \"2.5\".","type":"string"},"unit_price":{"description":"Decimal string such as \"120.00\".","type":"string"}},"additionalProperties":false,"required":["description","quantity","unit_price"]}},"tax_percent":{"description":"Decimal string such as \"19\". Leave out for no tax line.","type":["string","null"],"default":null},"notes":{"type":["string","null"],"default":null},"paper":{"type":"string","enum":["a4","us-letter"],"default":"a4"}}},"PdfForgeReportInput":{"required":["title","sections"],"additionalProperties":false,"type":"object","properties":{"title":{"type":"string"},"subtitle":{"type":["string","null"],"default":null},"sections":{"type":"array","items":{"type":"object","properties":{"heading":{"type":["string","null"],"default":null},"paragraphs":{"type":"array","items":{"type":"string"},"default":[]},"table":{"type":["object","null"],"properties":{"columns":{"type":"array","items":{"type":"string"}},"rows":{"type":"array","items":{"type":"array","items":{"type":"string"}}}},"additionalProperties":false,"required":["columns","rows"]}},"additionalProperties":false}},"paper":{"type":"string","enum":["a4","us-letter"],"default":"a4"}}},"LinkPreviewPreviewInput":{"required":["url"],"additionalProperties":false,"type":"object","properties":{"url":{"description":"A public http or https URL of an HTML page.","type":"string"}}},"WebExtractExtractInput":{"required":["schema"],"additionalProperties":false,"type":"object","properties":{"url":{"description":"A public http or https URL. Give this or `content`.","type":["string","null"],"default":null},"content":{"description":"HTML or plain text you already have, up to 1 MB. Give this or `url`. No personal data.","type":["string","null"],"default":null},"schema":{"description":"JSON Schema the answer must match."}}},"IbanVatIbanInput":{"required":["iban"],"additionalProperties":false,"type":"object","properties":{"iban":{"description":"The IBAN as typed; spaces, dots and dashes are ignored.","type":"string"}}},"IbanVatVatInput":{"required":["number"],"additionalProperties":false,"type":"object","properties":{"number":{"description":"The VAT number, with its country prefix (`RO14399840`) unless `country` is given.","type":"string"},"country":{"description":"Two-letter country code, when the number has no prefix. `GR` is read as `EL`.","type":["string","null"],"default":null}}},"ChartRendererRenderInput":{"required":["type"],"additionalProperties":false,"type":"object","properties":{"type":{"description":"The kind of chart.","oneOf":[{"description":"Vertical bars. Several series sit side by side, or on top of each other with `stacked`.","type":"string","const":"column"},{"description":"Horizontal bars: best for ranking and long names.","type":"string","const":"bar"},{"description":"Change over time. Up to 8 series.","type":"string","const":"line"},{"description":"A line with the space under it filled; `stacked` adds the series up.","type":"string","const":"area"},{"description":"Dots at `[x, y]`; a third number sizes each dot. Up to 3 series.","type":"string","const":"scatter"},{"description":"Parts of a whole as a ring with the total in the middle.","type":"string","const":"donut"},{"description":"Parts of a whole as a disc.","type":"string","const":"pie"},{"description":"Parts of a whole as one segmented bar: the clearest way to show shares.","type":"string","const":"share"},{"description":"One big number, how it changed, and a small trend line.","type":"string","const":"stat"},{"description":"Just the trend line, for embedding next to a number.","type":"string","const":"sparkline"},{"description":"Progress towards a maximum.","type":"string","const":"meter"},{"description":"A grid of cells, darker where the value is larger. Each series is a row.","type":"string","const":"heatmap"},{"description":"Stages in order, with how much carried over from each to the next.","type":"string","const":"funnel"}]},"title":{"description":"Headline above the chart. Say what the reader should see, not just what is plotted.","type":["string","null"],"default":null},"subtitle":{"type":["string","null"],"default":null},"caption":{"description":"Small print under the chart, such as the source.","type":["string","null"],"default":null},"labels":{"description":"Names along the axis, or of the slices, stages or heatmap columns.","type":"array","items":{"type":"string"},"default":[]},"series":{"description":"The data, one entry per series.","type":"array","items":{"type":"object","properties":{"name":{"description":"Shown in the legend. For a heatmap, the row name.","type":["string","null"],"default":null},"values":{"description":"One number per label.","type":"array","items":{"type":"number","format":"double"},"default":[]},"points":{"description":"Scatter only: `[x, y]` or `[x, y, size]` per dot.","type":"array","items":{"type":"array","items":{"type":"number","format":"double"}},"default":[]}},"additionalProperties":false}},"values":{"description":"Shorthand for a single unnamed series.","type":"array","items":{"type":"number","format":"double"},"default":[]},"value":{"description":"`stat` and `meter`: the number shown.","type":["number","null"],"format":"double","default":null},"max":{"description":"`meter`: what counts as full. Default 100.","type":["number","null"],"format":"double","default":null},"delta":{"description":"`stat`: change in percent against the last period, such as 12.4 or -3.","type":["number","null"],"format":"double","default":null},"delta_label":{"description":"`stat`: what the change is measured against, such as \"vs last month\".","type":["string","null"],"default":null},"lower_is_better":{"description":"`stat`: a fall is the good direction (costs, errors, churn).","type":"boolean","default":false},"center_label":{"description":"`donut`: the word under the total. Default \"total\".","type":["string","null"],"default":null},"theme":{"oneOf":[{"description":"Near-white, quiet. The default.","type":"string","const":"light"},{"description":"Near-black with brighter series.","type":"string","const":"dark"},{"description":"Warm cream, like a printed report.","type":"string","const":"paper"},{"description":"Cool grey-blue, for slides and dashboards.","type":"string","const":"slate"},{"description":"Deep navy.","type":"string","const":"midnight"},{"description":"Green-tinted black with a monospaced face.","type":"string","const":"terminal"}]},"backdrop":{"description":"A gradient behind the chart, which then sits on it as a rounded card with a shadow.","oneOf":[{"description":"The chart fills the image.","type":"string","const":"none"},{"description":"Green into blue into violet.","type":"string","const":"aurora"},{"description":"Orange into pink.","type":"string","const":"sunset"},{"description":"Teal into deep blue.","type":"string","const":"ocean"},{"description":"Violet into indigo.","type":"string","const":"dusk"},{"description":"Soft green into aqua.","type":"string","const":"mint"},{"description":"Charcoal greys.","type":"string","const":"graphite"}]},"colors":{"description":"Your own series colours as hex, in order, replacing the theme's. Up to 8.","type":"array","items":{"type":"string"},"default":[]},"size":{"oneOf":[{"description":"1200 × 675, for slides, docs and posts.","type":"string","const":"wide"},{"description":"1080 × 1080.","type":"string","const":"square"},{"description":"1080 × 1350.","type":"string","const":"portrait"},{"description":"1080 × 1920, for stories and phones.","type":"string","const":"story"},{"description":"1200 × 630, the link-preview size.","type":"string","const":"og"},{"description":"1500 × 500.","type":"string","const":"banner"},{"description":"640 × 360, for emails and dashboards.","type":"string","const":"small"}]},"width":{"description":"Width in pixels, 240 to 2400. Give `height` too; together they replace `size`.","type":["integer","null"],"format":"uint32","minimum":0,"default":null},"height":{"type":["integer","null"],"format":"uint32","minimum":0,"default":null},"scale":{"description":"2 or 3 for sharper PNGs on high-density screens. Default 1.","type":["integer","null"],"format":"uint32","minimum":0,"default":null},"format":{"oneOf":[{"type":"string","enum":["png"]},{"description":"Vector. Text uses the Inter (or IBM Plex Mono) font if the viewer has it.","type":"string","const":"svg"}]},"stacked":{"description":"Add the series up instead of placing them side by side (column, bar, area).","type":"boolean","default":false},"smooth":{"description":"Curved lines that never overshoot the data.","type":"boolean","default":false},"markers":{"description":"A dot on every point of a line. Default: on up to 24 points.","type":["boolean","null"],"default":null},"value_labels":{"description":"Print values on the marks. Default: on where they fit without clutter.","type":["boolean","null"],"default":null},"legend":{"description":"Set false to hide the legend.","type":["boolean","null"],"default":null},"y_min":{"description":"Start of the value axis. Bars always include zero.","type":["number","null"],"format":"double","default":null},"y_max":{"type":["number","null"],"format":"double","default":null},"prefix":{"description":"Written before every number, such as \"$\" or \"€\".","type":["string","null"],"default":null},"suffix":{"description":"Written after every number, such as \"%\" or \" ms\".","type":["string","null"],"default":null},"highlight":{"description":"The one series (or, with a single series, the one label) to show in colour; the rest go grey.","type":["string","null"],"default":null},"goal":{"description":"A reference line at this value, such as a target.","type":["number","null"],"format":"double","default":null},"goal_label":{"type":["string","null"],"default":null},"sort":{"description":"Order a single series from largest to smallest (column, bar).","type":"boolean","default":false}}},"PhoneCheckCheckInput":{"required":["number"],"additionalProperties":false,"type":"object","properties":{"number":{"description":"The number as typed: `+40 721 234 567`, `0721 234 567`, `(212) 555-0123`.","type":"string"},"country":{"description":"Two-letter country to assume when the number has no `+` prefix, such as `RO` or `US`.","type":["string","null"],"default":null}}},"FxRatesRatesInput":{"additionalProperties":false,"properties":{"base":{"description":"The currency the rates are quoted against. Default EUR.","type":["string","null"],"default":null},"symbols":{"description":"Only these currencies. Default: all.","type":"array","items":{"type":"string"},"default":[]},"date":{"description":"A day in the last 90, as YYYY-MM-DD. Default: the latest published.","type":["string","null"],"default":null}},"type":"object"},"FxRatesConvertInput":{"required":["amount","from","to"],"additionalProperties":false,"type":"object","properties":{"amount":{"type":"number","format":"double"},"from":{"description":"Three-letter currency code, such as USD.","type":"string"},"to":{"type":"string"},"date":{"description":"A day in the last 90, as YYYY-MM-DD. Default: the latest published.","type":["string","null"],"default":null}}},"SheetConvertReadInput":{"additionalProperties":false,"properties":{"file_url":{"description":"Direct link to an .xlsx, .xlsm, .xls, .ods, .csv or .tsv file, up to 15 MB.","type":["string","null"],"default":null},"file_base64":{"description":"The file itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"sheet":{"description":"One sheet by name. Left out, every sheet is returned.","type":["string","null"],"default":null},"header":{"description":"`true` (the default): the first row names the columns and each row is an object.\n`false`: each row is an array.","type":["boolean","null"],"default":null},"max_rows":{"description":"Most rows returned per sheet: 1 to 50,000, 10,000 if left out.","type":["integer","null"],"format":"uint","minimum":0,"default":null}},"type":"object"},"SheetConvertWriteInput":{"required":["sheets"],"additionalProperties":false,"type":"object","properties":{"sheets":{"description":"One to twenty sheets, 200,000 cells in all.","type":"array","items":{"type":"object","properties":{"name":{"description":"The sheet's name: up to 31 characters, none of `[ ] : * ? / \\`.","type":"string"},"rows":{"description":"Rows as objects (their keys become the header row) or as arrays.","type":"array","items":true},"columns":{"description":"The order of the columns when rows are objects. Left out, keys go in alphabetical\norder; keys not listed follow the listed ones.","type":["array","null"],"items":{"type":"string"},"default":null}},"additionalProperties":false,"required":["name","rows"]}}}},"FileToMarkdownConvertInput":{"additionalProperties":false,"properties":{"file_url":{"description":"Direct link to the file, up to 15 MB.","type":["string","null"],"default":null},"file_base64":{"description":"The file itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"filename":{"description":"The file's name. Only its extension is used, to tell a .csv or .html from plain text.","type":["string","null"],"default":null},"max_chars":{"description":"Most characters of Markdown returned: up to 2,000,000, 200,000 if left out.","type":["integer","null"],"format":"uint","minimum":0,"default":null}},"type":"object"},"SeoAuditAuditInput":{"required":["url"],"additionalProperties":false,"type":"object","properties":{"url":{"description":"A public http or https URL of an HTML page.","type":"string"}}},"EmailCheckCheckInput":{"required":["email"],"additionalProperties":false,"type":"object","properties":{"email":{"description":"The address to check, such as `jane@example.com`.","type":"string"}}},"AudioCleanupCleanInput":{"required":["max_minutes"],"additionalProperties":false,"type":"object","properties":{"audio_url":{"description":"Direct https link to an audio or video file (up to 350 MB). Not a YouTube or TikTok page.","type":["string","null"],"default":null},"audio_base64":{"description":"The file itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"max_minutes":{"description":"The most the audio can last, 1 to 60. This much is held; only the seconds it measures\nare charged. Longer audio is refused and refunded.","type":"integer","format":"uint64","minimum":0},"background":{"description":"Also return what was removed, as a second MP3.","type":"boolean","default":false},"callback_url":{"description":"Told the job's id and status when it ends, signed with your webhook secret.","type":["string","null"],"default":null}}},"PiiRedactRedactInput":{"required":["text"],"additionalProperties":false,"type":"object","properties":{"text":{"description":"Up to 100,000 characters.","type":"string"},"labels":{"description":"What to look for. Left out, everything: person, email, phone_number, address, date,\ndate_of_birth, organization, iban, credit_card_number, bank_account_number,\npassport_number, id_number, tax_id, ip_address, url, username, password.","type":["array","null"],"items":{"type":"string"},"default":null},"threshold":{"description":"How sure the model must be, 0.1 to 0.99. Lower finds more and is wrong more often.\n0.6 if left out.","type":["number","null"],"format":"double","default":null},"mask":{"oneOf":[{"description":"`[EMAIL]`, `[PERSON]` and so on.","type":"string","const":"label"},{"description":"As many asterisks as the text they replace.","type":"string","const":"stars"},{"description":"Leave the text as it is and only report what was found.","type":"string","const":"none"}]}}},"AiTextScoreScoreInput":{"required":["text"],"additionalProperties":false,"type":"object","properties":{"text":{"description":"English text, 200 to 100,000 characters. Long texts are sampled along their length.","type":"string"}}},"DocumentReaderReadInput":{"additionalProperties":false,"properties":{"file_url":{"description":"Direct link to a PNG, JPEG, WebP or PDF file, up to 15 MB.","type":["string","null"],"default":null},"file_base64":{"description":"The file itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"mode":{"oneOf":[{"description":"Everything on the page as text.","type":"string","const":"text"},{"description":"The page's table as HTML.","type":"string","const":"table"},{"description":"Only the fields named in `fields`, as JSON.","type":"string","const":"fields"}],"default":"text"},"fields":{"description":"For mode=fields: the names to fill in, as an object with empty values, such as\n`{\"invoice_number\": \"\", \"total_text\": \"\"}`. Up to 40 names; an object may nest, and a\nlist with one example asks for every such thing on the page. End a name in `_text` to\nget a number exactly as printed: asked for a plain `total`, the model can read\n\"15.172,50\" as 15.1725.","type":["object","null"],"additionalProperties":true,"default":null},"page":{"description":"Which page of a PDF to read, from 1. The first if left out.","type":["integer","null"],"format":"uint32","minimum":0,"default":null}},"type":"object"},"InvoiceParserParseInput":{"additionalProperties":false,"properties":{"file_url":{"description":"Direct link to a PNG, JPEG, WebP or PDF file, up to 15 MB.","type":["string","null"],"default":null},"file_base64":{"description":"The file itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"pages":{"description":"How many pages of a PDF to read, from the first. Each page read is one unit.","type":["integer","null"],"format":"uint32","minimum":0,"default":null}},"type":"object"},"ReceiptParserParseInput":{"additionalProperties":false,"properties":{"file_url":{"description":"Direct link to a PNG, JPEG, WebP or PDF file, up to 15 MB.","type":["string","null"],"default":null},"file_base64":{"description":"The file itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"pages":{"description":"How many pages of a PDF to read, from the first. Each page read is one unit.","type":["integer","null"],"format":"uint32","minimum":0,"default":null}},"type":"object"},"ResumeParserParseInput":{"additionalProperties":false,"properties":{"file_url":{"description":"Direct link to a PNG, JPEG, WebP or PDF file, up to 15 MB.","type":["string","null"],"default":null},"file_base64":{"description":"The file itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"pages":{"description":"How many pages of a PDF to read, from the first. Each page read is one unit.","type":["integer","null"],"format":"uint32","minimum":0,"default":null}},"type":"object"},"NsfwCheckCheckInput":{"additionalProperties":false,"properties":{"image_url":{"description":"Direct link to a PNG, JPEG or WebP, up to 15 MB.","type":["string","null"],"default":null},"image_base64":{"description":"The image itself, base64, when it fits in the 2 MB request limit.","type":["string","null"],"default":null},"threshold":{"description":"The score from which the image is flagged, 0.05 to 0.95. 0.5 if left out.","type":["number","null"],"format":"double","default":null}},"type":"object"},"TextClassifyClassifyInput":{"required":["text","questions"],"additionalProperties":false,"type":"object","properties":{"text":{"description":"Up to 4,000 characters.","type":"string"},"questions":{"description":"One to ten questions by name. Each is a list of 2 to 30 labels to choose one from,\nsuch as `{\"team\": [\"billing\", \"shipping\"]}`, or `{\"labels\": [...], \"multi\": true}` to\nget every label that fits.","type":"object","additionalProperties":true}}},"EntityExtractExtractInput":{"required":["text","labels"],"additionalProperties":false,"type":"object","properties":{"text":{"description":"Up to 100,000 characters.","type":"string"},"labels":{"description":"1 to 30 kinds of thing to find, in plain words, each up to 80 characters.","type":"array","items":{"type":"string"}},"threshold":{"description":"How sure the model must be, 0.1 to 0.99. Lower finds more and is wrong more often.\n0.5 if left out.","type":["number","null"],"format":"double","default":null}}},"JobAccepted":{"type":"object","properties":{"job_id":{"type":"string","format":"uuid"},"status":{"type":"string"},"status_url":{"type":"string"},"result_url":{"type":"string"}}}},"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"},"apiKey":{"type":"apiKey","in":"header","name":"X-Api-Key"}}}}