{"openapi":"3.1.0","info":{"title":"API Reference","version":"1.0.0"},"paths":{"/detect":{"get":{"operationId":"deepfakeDetection_listDetections","summary":"List all detects","description":"Retrieve a paginated list of all detect objects for the authenticated user's team","tags":["deepfakeDetection"],"parameters":[{"name":"page","in":"query","description":"Page number (must be >= 1)","required":true,"schema":{"type":"integer","minimum":1}},{"name":"page_size","in":"query","description":"Number of items per page (10-1000)","required":false,"schema":{"type":"integer","minimum":10,"maximum":1000,"default":10}}],"responses":{"200":{"description":"List of detects","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deepfake_Detection_listDetections_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"deepfakeDetection_createDetection","summary":"Create deepfake detection","description":"Analyze audio, image, and video for deepfake detection.\n\nSupply media via one of three intake methods:\n\n- **Direct file upload** — `multipart/form-data` with the file attached as `file`. Files must be 150 MB or smaller and use one of the supported audio/video/image extensions. For larger files, use the secure upload flow.\n- **Public URL** — `application/json` with a `url` field. The API fetches the URL itself.\n- **Secure upload token** — `application/json` with a `media_token` field obtained from `POST /secure_uploads`.\n\nExactly one of `file`, `url`, or `media_token` must be provided per request.\n\nSet `detect_watermark=true` to run Resemble watermark detection and SynthID alongside the deepfake\nanalysis. This option supports single audio, image, and video requests only. It adds one Watermark\ndetection charge, applies a 200 MB source limit for audio, image, and video, and causes\n`Prefer: wait` and callbacks to wait for the watermark analysis to reach a terminal state. A watermark\nfailure is returned in the nested `watermark` object and does not change the deepfake verdict.\n","tags":["deepfakeDetection"],"responses":{"200":{"description":"Detection job created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deepfake_Detection_createDetection_Response_200"}}}},"400":{"description":"Invalid request, including a malformed `detect_watermark` boolean or a known source that exceeds the Watermark decoder limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Insufficient balance for the combined Detect request. When watermark analysis was requested, details include `watermark_cost_cents`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDetectionRequestPaymentRequiredError"}}}},"403":{"description":"The API key does not have access to Watermark detection or another requested product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The media file to analyze (audio, video, or image). Must be 150 MB or smaller."},"callback_url":{"type":"string","format":"uri","description":"POST destination for the detection result."},"wait_for_intelligence":{"type":"boolean","description":"Controls callback timing when callback_url and intelligence=true are provided. True waits without a forced timeout until Detect and Intelligence are both finished. False sends after Detect finishes without waiting for Intelligence. When omitted, the callback waits up to 10 minutes for Intelligence before sending the result state available at that time."},"visualize":{"type":"boolean","description":"Generate visualization artifacts"},"frame_length":{"type":"integer","minimum":1,"maximum":4,"default":2,"description":"Window size in seconds (audio/video)"},"start_region":{"type":"number","format":"double","description":"Start of segment to analyze (seconds)"},"end_region":{"type":"number","format":"double","description":"End of segment to analyze (seconds)"},"max_video_secs":{"type":"number","format":"double","description":"Cap processed duration"},"modality":{"$ref":"#/components/schemas/DetectPostRequestBodyContentMultipartFormDataSchemaModality","description":"Video only. Selects which detection components run for a video file:\n`audio` (audio track only), `video` (visual frames only), or `all` (both — the default).\nIgnored for audio and image inputs. Invalid values are rejected with HTTP 400.\n"},"face_only":{"type":"boolean","default":false,"description":"Focus visual video detection on faces by masking non-face regions. Effective only for\nvideo inputs with `modality=all` or `modality=video`. Audio, image, and `modality=audio`\nvideo requests are accepted but use an effective value of `false`.\n"},"intelligence":{"type":"boolean","default":false,"description":"Run multimodal intelligence analysis on the media"},"detect_watermark":{"type":"boolean","default":false,"description":"Run Resemble watermark detection and SynthID. Supported for single audio, image, and video requests. Adds the Watermark detection charge and applies a source limit of 200 MB for audio, image, and video."},"infer_from_intelligence":{"type":"boolean","default":false,"description":"Opt in to let a strong intelligence finding escalate an otherwise non-fake verdict to \"Likely Fake\". Has no effect unless `intelligence` is also true."},"audio_source_tracing":{"type":"boolean","default":false,"description":"Enable audio source tracing to identify synthetic audio origin"},"signal":{"type":"boolean","default":false,"description":"Run Signal content analysis after detection completes, classifying the media against fraud and abuse categories. Requires Signal access on your plan and cannot be combined with zero_retention_mode. Not supported for batch detections."},"use_reverse_search":{"type":"boolean","default":false,"description":"Enable reverse image search to improve detection accuracy for image files. Only applies to image detections."},"use_ood_detector":{"type":"boolean","default":false,"description":"Enable out-of-distribution detection"},"zero_retention_mode":{"type":"boolean","default":false,"description":"Enable Zero Retention Mode to automatically delete submitted media after detection completes."}},"required":["file"]}}}},"security":[{"BearerAuth":[]}]}},"/detect/{uuid}":{"get":{"operationId":"deepfakeDetection_getDetection","summary":"Get deepfake detection result","description":"Get a deepfake detection result by UUID. For an otherwise successful Detect with watermark analysis, item status remains processing until the linked analysis completes or fails. A core detection failure still reports failed. Intelligence runs separately and can still be processing after Detect reaches completed.","tags":["deepfakeDetection"],"parameters":[{"name":"uuid","in":"path","description":"The UUID of the detect object","required":true,"schema":{"type":"string"}},{"name":"experts","in":"query","description":"When true, return all successfully completed Intelligence results as an array, or an empty array when none have completed successfully. When omitted or false, return one completed result when available; otherwise, return the current processing or failed result.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Detection result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deepfake_Detection_getDetection_Response_200"}}}},"404":{"description":"Detect not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"operationId":"deepfakeDetection_deleteDetection","summary":"Delete deepfake detection","description":"Delete a detection belonging to the authenticated user's team. Once deleted, the detection is no longer returned by list or get requests.","tags":["deepfakeDetection"],"parameters":[{"name":"uuid","in":"path","description":"The UUID of the detect object","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Detection deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deepfake_Detection_deleteDetection_Response_200"}}}},"404":{"description":"Detect not found. Unknown UUIDs and detects belonging to another team are indistinguishable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]}},"/detect/batch":{"post":{"operationId":"deepfakeDetection_createDetectBatch","summary":"Create a batch deepfake detection job","description":"Submit up to 50 files in a single request and process them as a single logical\ngroup. Returns HTTP 202 with a batch UUID; each file is analyzed in the\nbackground and individual results are available via `GET /detect/{uuid}` for\neach entry in `detect_uuids`.\n\nTwo intake methods:\n\n- **Multiple media files** — repeated `files[]` form fields.\n- **Single zip archive** — a single `file` form field whose value is a `.zip`\n  containing the media files. Non-media entries are skipped.\n\nProvide one of `files[]` or `file=<...>.zip` per request. Synchronous mode\n(`Prefer: wait`) is not supported and returns 400 if sent.\n\nConstraints:\n\n- Maximum 50 files per batch.\n- Maximum 500 MB total upload size across all files.\n- Allowed file types match `POST /detect`'s direct-upload allowlist.\n- Watermark analysis is not supported for batch or zip requests. Sending `detect_watermark=true` returns 400.\n- All-or-nothing billing: if the team's wallet cannot cover the projected cost\n  for every file, the request is rejected with 402 and no detects are created.\n","tags":["deepfakeDetection"],"responses":{"202":{"description":"Batch accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deepfake_Detection_createDetectBatch_Response_202"}}}},"400":{"description":"Invalid batch request (missing files, both file and files[] supplied, file count or size exceeded, unsupported file type, `Prefer: wait` header sent, or `detect_watermark=true`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Insufficient balance for the projected batch cost. Response `details` includes per-file estimates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Intelligence detect limit reached (Default plan).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"files[]":{"type":"array","items":{"type":"string","format":"binary"},"description":"One or more media files. Repeat the `files[]` field for each file. Mutually exclusive with `file`."},"file":{"type":"string","format":"binary","description":"A single `.zip` archive containing media files. Mutually exclusive with `files[]`."},"callback_url":{"type":"string","format":"uri","description":"POST destination invoked when the batch reaches a terminal state."},"intelligence":{"type":"boolean","default":false,"description":"Run multimodal intelligence on every file in the batch."},"infer_from_intelligence":{"type":"boolean","default":false,"description":"Opt in to let a strong intelligence finding escalate an otherwise non-fake verdict to \"Likely Fake\". Has no effect unless `intelligence` is also true."},"search_identity":{"type":"boolean","default":false,"description":"Run identity search against the team's saved identities (audio/video only)."},"visualize":{"type":"boolean","default":true,"description":"Generate visualization artifacts."},"audio_source_tracing_enabled":{"type":"boolean","default":false,"description":"Enable audio source tracing on each audio file."},"frame_length":{"type":"integer","minimum":1,"maximum":4,"description":"Window size in seconds (audio/video)."},"start_region":{"type":"number","format":"double","description":"Start of segment to analyze (seconds)."},"end_region":{"type":"number","format":"double","description":"End of segment to analyze (seconds)."},"max_video_secs":{"type":"number","format":"double","description":"Cap processed video duration."},"use_llm":{"type":"boolean","description":"Use LLM-assisted video analysis."},"face_only":{"type":"boolean","default":false,"description":"Focus detection on faces for video children by masking non-face regions. Audio and\nimage children use an effective value of `false`. Retrieve each child's effective value\nwith `GET /detect/{uuid}`; the aggregate batch response does not include this field.\n"},"zero_retention_mode":{"type":"boolean","default":false,"description":"Enable Zero Retention Mode for every file in the batch."}}}}}},"security":[{"BearerAuth":[]}]}},"/detect/batch/{uuid}":{"get":{"operationId":"deepfakeDetection_getDetectBatch","summary":"Get batch status","description":"Retrieve the latest aggregate status for a batch. The response shape mirrors\nthe create response — `status`, `completed_count`, and `failed_count` update\nas child detects progress. Use the `detect_uuids` array to fetch per-file\nresults via `GET /detect/{uuid}`.\n","tags":["deepfakeDetection"],"parameters":[{"name":"uuid","in":"path","description":"Batch UUID returned by `POST /detect/batch`.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Batch status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deepfake_Detection_getDetectBatch_Response_200"}}}},"404":{"description":"Batch not found (or not accessible by the authenticated team).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]}},"/detect/{uuid}/feedback":{"get":{"operationId":"deepfakeDetection_getDetectFeedback","summary":"Get detection feedback","description":"Retrieve your own feedback for a detect. Returns 404 when *you* haven't answered this\ndetect, even if the detect exists and a teammate has answered it.\n","tags":["deepfakeDetection"],"parameters":[{"name":"uuid","in":"path","description":"UUID of the detect.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Feedback","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deepfake_Detection_getDetectFeedback_Response_200"}}}},"404":{"description":"No such detect for the authenticated team, or you have not left feedback on it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"deepfakeDetection_createDetectFeedback","summary":"Submit detection feedback","description":"Tell Resemble whether a detection verdict was right — and when it wasn't, what it\nshould have been. The answer is stored with a snapshot of what the model said at the\ntime of submission (verdict, score, media type, raw metrics), so it stays interpretable\neven if the detect is later re-run or deleted.\n\nUpserts on `(detect, user)`: re-posting edits your existing answer rather than adding a\nsecond one. There is no separate update call. Feedback is per user, not per team — a\nteammate's answer on the same detect is invisible to you.\n\nThe detect must have completed processing; feedback on a pending or failed detect is\nrejected with 400. Teams without Detect access also receive 400 (not 403).\n","tags":["deepfakeDetection"],"parameters":[{"name":"uuid","in":"path","description":"UUID of the completed detect.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Feedback recorded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deepfake_Detection_createDetectFeedback_Response_200"}}}},"400":{"description":"Unknown or missing `type`, `comment` over 1000 characters, the detect has not completed processing, or the team does not have Detect access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No such detect for the authenticated team.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DetectUuidFeedbackPostRequestBodyContentApplicationJsonSchemaType","description":"What the verdict should have been.\n  - `correct` — the verdict was right.\n  - `should_be_ai_generated` — we said authentic; it is AI-generated.\n  - `should_be_authentic` — we said AI-generated; it is genuine and unaltered.\n  - `should_be_non_ai` — no model generated it, but it may still be edited, spliced, or a human impersonation.\n  - `should_be_neutral` — neither call is right; the media is genuinely ambiguous.\n  - `skipped` — the verdict was wrong, but the reviewer didn't say how.\n"},"comment":{"type":"string","maxLength":1000,"description":"Free text, up to 1000 characters. Trimmed; blank becomes `null`."},"source":{"type":"string","default":"api","description":"Where the answer came from. Use a stable, aggregatable value such as a product\nor queue name — not a per-request identifier. Truncated to 64 characters\nrather than rejected.\n"}},"required":["type"]}}}},"security":[{"BearerAuth":[]}]},"delete":{"operationId":"deepfakeDetection_deleteDetectFeedback","summary":"Delete detection feedback","description":"Retract your own feedback. Idempotent — returns 200 whether or not a row existed. Only\nyour row is removed; a teammate's answer on the same detect is untouched. Works even on\na detect that later failed.\n","tags":["deepfakeDetection"],"parameters":[{"name":"uuid","in":"path","description":"UUID of the detect.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Feedback retracted (or none existed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deepfake_Detection_deleteDetectFeedback_Response_200"}}}},"404":{"description":"No such detect for the authenticated team.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]}},"/agents":{"get":{"operationId":"detectAgents_listDetectAgents","summary":"List Detect Agents","description":"Return all six managed Detect Agents available to the authenticated team.\nUse an agent's `uuid` to run an investigation or retrieve its run history.\nThis endpoint does not accept pagination or filtering parameters.\n","tags":["detectAgents"],"responses":{"200":{"description":"All six Detect Agents","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Detect_Agents_listDetectAgents_Response_200"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account does not have Detect Agents access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Detect Agents service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]}},"/agents/{uuid}/run":{"post":{"operationId":"detectAgents_runDetectAgentInvestigation","summary":"Run investigation","description":"Run a managed Detect Agent against uploaded media or a public URL.\nThe response is a live Server-Sent Events stream. The first `run_started`\nevent contains the persisted run identifier.\n","tags":["detectAgents"],"parameters":[{"name":"uuid","in":"path","description":"Stable Detect Agent identifier returned by `GET /agents`.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"The investigation is blocked by billing or available credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account does not have Detect Agents access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Detect Agent not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Neither `file` nor `url` was provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Detect Agents service unavailable before streaming begins","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"Primary media to analyze. Required when `url` is omitted."},"url":{"type":"string","format":"uri","description":"Public media URL to analyze. Required when `file` is omitted."},"query":{"type":"string","description":"Question or investigation objective."},"evidence[]":{"type":"array","items":{"type":"string","format":"binary"},"description":"Supporting evidence files. Repeat this field for multiple files."},"check_urls":{"type":"string","description":"Additional URLs for the Detect Agent to check."}}}}}},"security":[{"BearerAuth":[]}]}},"/agents/{uuid}/runs":{"get":{"operationId":"detectAgents_listDetectAgentInvestigationRuns","summary":"List investigation runs","description":"Return up to 100 of a Detect Agent's most recent investigation runs in\nnewest-first order. An agent that the team has never run returns an empty list.\n","tags":["detectAgents"],"parameters":[{"name":"uuid","in":"path","description":"Stable Detect Agent identifier returned by `GET /agents`.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Recent investigation runs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Detect_Agents_listDetectAgentInvestigationRuns_Response_200"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account does not have Detect Agents access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Detect Agent not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Detect Agents service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]}},"/agents/{uuid}/runs/{run_id}":{"get":{"operationId":"detectAgents_getDetectAgentInvestigationRun","summary":"Get investigation run","description":"Retrieve a persisted investigation run, including its replay transcript\nand the exact configuration and memory snapshots used by the investigation.\n","tags":["detectAgents"],"parameters":[{"name":"uuid","in":"path","description":"Stable Detect Agent identifier returned by `GET /agents`.","required":true,"schema":{"type":"string"}},{"name":"run_id","in":"path","description":"Run UUID returned by a `run_started` event or run-list response.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Investigation run details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Detect_Agents_getDetectAgentInvestigationRun_Response_200"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The account does not have Detect Agents access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Detect Agent or investigation run not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Detect Agents service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]}},"/intelligence":{"post":{"operationId":"intelligence_runIntelligence","summary":"Run intelligence","description":"Analyze audio, image, or video for comprehensive insights. Optionally reference an existing detect to associate.","tags":["intelligence"],"responses":{"200":{"description":"Intelligence analysis","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Intelligence_runIntelligence_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"media_token":{"type":"string","description":"Token for uploaded media file (from secure upload)"},"url":{"type":"string","format":"uri","description":"HTTPS URL to audio, image, or video file"},"detect_id":{"type":"string","format":"uuid","description":"UUID of an existing detect to associate"},"media_type":{"$ref":"#/components/schemas/IntelligencePostRequestBodyContentApplicationJsonSchemaMediaType","description":"Explicit media type (auto-detected if not provided)"},"callback_url":{"type":"string","format":"uri","description":"URL that receives the final intelligence payload via HTTP POST. When present, the request runs asynchronously and returns 202 Accepted."}}}}}},"security":[{"BearerAuth":[]}]}},"/intelligences":{"get":{"operationId":"intelligence_listIntelligences","summary":"List intelligences","description":"Retrieve a paginated list of all intelligence reports for the authenticated user's team","tags":["intelligence"],"parameters":[{"name":"page","in":"query","description":"Page number (must be >= 1)","required":true,"schema":{"type":"integer","minimum":1}},{"name":"page_size","in":"query","description":"Number of items per page (10-1000)","required":false,"schema":{"type":"integer","minimum":10,"maximum":1000,"default":10}}],"responses":{"200":{"description":"List of intelligence reports","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Intelligence_listIntelligences_Response_200"}}}}},"security":[{"BearerAuth":[]}]}},"/intelligences/{uuid}":{"get":{"operationId":"intelligence_getIntelligence","summary":"Get intelligence","description":"Retrieve a single intelligence report by its UUID","tags":["intelligence"],"parameters":[{"name":"uuid","in":"path","description":"The UUID of the intelligence report","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Intelligence report","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Intelligence_getIntelligence_Response_200"}}}},"404":{"description":"Intelligence not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]}},"/detects/{uuid}/intelligence":{"post":{"operationId":"detectIntelligence_askDetectIntelligenceQuestion","summary":"Ask a question about a detection","description":"Submit a natural-language question about a completed detection report. Returns 202 Accepted while the answer is generated in the background.","tags":["detectIntelligence"],"parameters":[{"name":"uuid","in":"path","description":"UUID of the completed detection report","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Question accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Detect_Intelligence_askDetectIntelligenceQuestion_Response_202"}}}},"400":{"description":"Bad request (missing query)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Detection not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Detection not completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"The natural-language question to ask about the detection"}},"required":["query"]}}}},"security":[{"BearerAuth":[]}]}},"/detects/{uuid}/intelligence/{question_uuid}":{"get":{"operationId":"detectIntelligence_getDetectIntelligenceQuestion","summary":"Get answer to a detection question","description":"Retrieve the status and answer for a previously submitted question. Poll until status is completed or failed.","tags":["detectIntelligence"],"parameters":[{"name":"uuid","in":"path","description":"UUID of the detection report","required":true,"schema":{"type":"string"}},{"name":"question_uuid","in":"path","description":"UUID of the question","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Question status and answer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Detect_Intelligence_getDetectIntelligenceQuestion_Response_200"}}}},"404":{"description":"Question not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]}},"/audio_source_tracings":{"get":{"operationId":"audioSourceTracing_listAudioSourceTracings","summary":"List audio source tracings","description":"Retrieve a paginated list of all source tracing reports for the authenticated user's team","tags":["audioSourceTracing"],"parameters":[{"name":"page","in":"query","description":"Page number (must be >= 1)","required":true,"schema":{"type":"integer","minimum":1}},{"name":"page_size","in":"query","description":"Number of items per page (10-1000)","required":false,"schema":{"type":"integer","minimum":10,"maximum":1000,"default":10}}],"responses":{"200":{"description":"List of source tracing reports","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audio_Source_Tracing_listAudioSourceTracings_Response_200"}}}}},"security":[{"BearerAuth":[]}]}},"/audio_source_tracings/{uuid}":{"get":{"operationId":"audioSourceTracing_getAudioSourceTracing","summary":"Get audio source tracing","description":"Retrieve a single source tracing report by its UUID","tags":["audioSourceTracing"],"parameters":[{"name":"uuid","in":"path","description":"The UUID of the source tracing report","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Source tracing report","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audio_Source_Tracing_getAudioSourceTracing_Response_200"}}}},"404":{"description":"Source tracing report not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]}},"/identity":{"get":{"operationId":"identity_listIdentities","summary":"List identities","description":"List the team's identities, newest first","tags":["identity"],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","minimum":10,"maximum":1000,"default":10}},{"name":"search","in":"query","description":"Filter by identity name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of identities","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Identity_listIdentities_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"identity_createIdentity","summary":"Create identity","description":"Create a new identity profile. Two request forms are supported: the simple audio-only form (flat `name` + one audio source; creates a team-visible person identity and enrolls the voice immediately) and the multimodal form (a nested `identity` object with full control over type and visibility).\n","tags":["identity"],"responses":{"200":{"description":"Identity created (simple form)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Identity_createIdentity_Response_200"}}}},"422":{"description":"Validation failed or no audio source supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Identity_createIdentity_Request"}}}},"security":[{"BearerAuth":[]}]}},"/identity/{uuid}":{"delete":{"operationId":"identity_deleteIdentity","summary":"Delete identity","description":"Delete an identity and withdraw its enrollment from matching","tags":["identity"],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Identity deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Identity_deleteIdentity_Response_200"}}}},"403":{"description":"The identity belongs to another team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]}},"/identity/{uuid}/attachments":{"post":{"operationId":"identity_createIdentityAttachment","summary":"Add reference media","description":"Attach a reference media file (voice sample, face photo, or reference video) to an identity. The modality's embedding recomputes asynchronously; the media becomes searchable once its embedding status is ready.\n","tags":["identity"],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Media attached; returns the updated identity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Identity"}}}},"400":{"description":"Missing or invalid modality, or missing file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Identity not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Face photo limit reached (a person identity accepts at most 5 face photos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"modality":{"$ref":"#/components/schemas/IdentityUuidAttachmentsPostRequestBodyContentMultipartFormDataSchemaModality"},"file":{"type":"string","format":"binary","description":"The media file to attach"}},"required":["modality","file"]}}}},"security":[{"BearerAuth":[]}]}},"/identity/{uuid}/attachments/{attachment_id}":{"delete":{"operationId":"identity_deleteIdentityAttachment","summary":"Remove reference media","description":"Detach a reference media file from an identity. The affected modality's embedding recomputes without the removed file.\n","tags":["identity"],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}},{"name":"attachment_id","in":"path","description":"The id of an entry in the identity's voice_samples, face_photos, or reference_videos array","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Media removed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Identity_deleteIdentityAttachment_Response_204"}}}},"404":{"description":"Identity or attachment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]}},"/identity/search":{"post":{"operationId":"identity_searchIdentities","summary":"Search identities","description":"Search the team's identities (plus global identities) for matches against a media sample. Supports audio (voice matching) and image (face/visual matching); video is not yet supported for synchronous search.\n","tags":["identity"],"responses":{"200":{"description":"Search results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Identity_searchIdentities_Response_200"}}}},"400":{"description":"Search failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Missing media or unsupported modality","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL to the media sample (one of url, file, signed_id is required)"},"signed_id":{"type":"string","description":"Signed ID from a secure upload"},"modality":{"$ref":"#/components/schemas/IdentitySearchPostRequestBodyContentApplicationJsonSchemaModality","description":"Inferred from the media's content type when omitted (defaults to audio)"},"top_k":{"type":"integer","minimum":1,"maximum":20,"default":1}}}}}},"security":[{"BearerAuth":[]}]}},"/watermark/apply":{"post":{"operationId":"watermark_applyWatermark","summary":"Apply watermark","description":"Apply a Perth v2 watermark to an audio, image, or video file. The media type is automatically detected from the file content. Processing is asynchronous unless the `Prefer: wait` header is supplied.","tags":["watermark"],"parameters":[{"name":"Prefer","in":"header","description":"When set to \"wait\", the API processes synchronously and returns the completed result.","required":false,"schema":{"$ref":"#/components/schemas/WatermarkApplyPostParametersPrefer"}}],"responses":{"200":{"description":"Watermark job created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatermarkApplyResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatermarkApplyRequest"}}}},"security":[{"BearerAuth":[]}]}},"/watermark/apply/{uuid}/result":{"get":{"operationId":"watermark_getWatermarkApplyResult","summary":"Get watermark apply result","description":"Retrieve the result of a watermark apply job.","tags":["watermark"],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Apply result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatermarkApplyResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/watermark/detect":{"post":{"operationId":"watermark_detectWatermark","summary":"Detect watermark","description":"Detect a watermark in an audio, image, or video file. Audio runs Perth v1 and Perth v2 concurrently; image/video is publicly reported as Perth v2. Processing is asynchronous unless the `Prefer: wait` header is supplied.","tags":["watermark"],"parameters":[{"name":"Prefer","in":"header","description":"When set to \"wait\", the API processes synchronously and returns the completed result with metrics.","required":false,"schema":{"$ref":"#/components/schemas/WatermarkDetectPostParametersPrefer"}}],"responses":{"200":{"description":"Detection job created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatermarkDetectResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatermarkDetectRequest"}}}},"security":[{"BearerAuth":[]}]}},"/watermark/detect/{uuid}/result":{"get":{"operationId":"watermark_getWatermarkDetectionResult","summary":"Get watermark detection result","description":"Retrieve the result of a watermark detection.","tags":["watermark"],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Detection result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatermarkDetectResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/text_detect":{"get":{"operationId":"textDetection_listTextDetections","summary":"List text detections","description":"Retrieve a paginated list of text detections for the authenticated user's team, newest first.","tags":["textDetection"],"parameters":[{"name":"page","in":"query","description":"Page number (must be >= 1)","required":true,"schema":{"type":"integer","minimum":1}},{"name":"page_size","in":"query","description":"Number of items per page (10-1000)","required":false,"schema":{"type":"integer","minimum":10,"maximum":1000,"default":10}}],"responses":{"200":{"description":"List of text detections","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextDetectListResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"textDetection_createTextDetection","summary":"Detect AI-generated text","description":"Submit a passage of text and classify it as AI-generated or human-written.\n\nProcessing is asynchronous by default: the response returns immediately with `status: processing`,\nand you can poll `GET /text_detect/{uuid}` or supply a `callback_url` to be notified. Send the\n`Prefer: wait` header to block until the verdict is available and receive the completed item in the\nsame response. Allow a generous client timeout when waiting, since the first request after a period\nof inactivity can take several minutes while the model warms up.\n\nRequests are rejected with a 400 when `text` is missing, exceeds 100,000 characters, or contains\nfewer than 25 words. Each successfully scored request bills one Text Detection unit; abstained\n(`uncertain`) results are not billed.\n","tags":["textDetection"],"parameters":[{"name":"Prefer","in":"header","description":"When set to \"wait\", the API processes synchronously and returns the completed result.","required":false,"schema":{"$ref":"#/components/schemas/TextDetectPostParametersPrefer"}}],"responses":{"200":{"description":"Text detection created (or completed when `Prefer: wait` was sent)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextDetectResponse"}}}},"400":{"description":"Invalid request: missing text, text over 100,000 characters, fewer than 25 words, invalid `thinking` or `threshold`, or malformed `callback_url`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextDetectRequest"}}}},"security":[{"BearerAuth":[]}]}},"/text_detect/{uuid}":{"get":{"operationId":"textDetection_getTextDetection","summary":"Get text detection","description":"Retrieve a text detection by UUID. Poll this endpoint until `status` is `completed` or `failed`.","tags":["textDetection"],"parameters":[{"name":"uuid","in":"path","description":"UUID of the text detection","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Text detection result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextDetectResponse"}}}},"400":{"description":"The detection belongs to another team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]}},"/signal":{"get":{"operationId":"signal_listSignalSubmissions","summary":"List submissions","description":"Retrieve past Signal submissions for your team, newest first.","tags":["signal"],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":10}}],"responses":{"200":{"description":"Paginated submissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalSubmissionListResponse"}}}},"403":{"description":"The account does not have Signal access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalError"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"signal_createSignalSubmission","summary":"Score content","description":"Score a piece of content against the fraud and scam categories available to your team\nand return a verdict with the best-matching categories.\n\nSupply exactly one of:\n\n- **Text** — `application/json` with a `text` field.\n- **File** — `multipart/form-data` with the media attached as `file`. Audio, image, and\n  video are supported, up to 15 MB. The media type is detected from the file's MIME type\n  unless `media_type` is supplied.\n","tags":["signal"],"responses":{"200":{"description":"Scored submission","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalScoreResponse"}}}},"400":{"description":"Neither text nor file was provided, or `media_type` is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalError"}}}},"403":{"description":"The account does not have Signal access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalError"}}}},"413":{"description":"File exceeds the 15 MB limit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string","description":"Text to analyze."}},"required":["text"]}}}},"security":[{"BearerAuth":[]}]}},"/signal/{id}":{"delete":{"operationId":"signal_deleteSignalSubmission","summary":"Delete submission","description":"Permanently delete a Signal submission belonging to your team.","tags":["signal"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Submission deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalSuccessResponse"}}}},"404":{"description":"Submission not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalError"}}}}},"security":[{"BearerAuth":[]}]}},"/signal/custom_categories":{"get":{"operationId":"signal_listSignalCustomCategories","summary":"List custom categories","description":"Retrieve the team's Signal settings, the built-in categories, the team's custom categories with their example phrases, and calibration status.","tags":["signal"],"responses":{"200":{"description":"Categories, settings, and calibration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalCustomCategoryListResponse"}}}},"403":{"description":"The account does not have Signal access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalError"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"signal_createSignalCustomCategory","summary":"Create custom category","description":"Create a custom fraud category from example phrases. Categories embed asynchronously:\na new category starts at `pending`, moves to `embedding`, and becomes usable for\nscoring once its status is `ready`.\n","tags":["signal"],"responses":{"200":{"description":"Category created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalCustomCategoryResponse"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalCustomCategoryCreateRequest"}}}},"security":[{"BearerAuth":[]}]}},"/signal/custom_categories/{id}":{"get":{"operationId":"signal_getSignalCustomCategory","summary":"Get custom category","description":"Retrieve a single custom category with its example phrases.","tags":["signal"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Custom category","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalCustomCategoryResponse"}}}},"404":{"description":"Category not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalError"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"operationId":"signal_deleteSignalCustomCategory","summary":"Delete custom category","description":"Delete a custom category and its example phrases.","tags":["signal"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Category deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalSuccessResponse"}}}},"404":{"description":"Category not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalError"}}}}},"security":[{"BearerAuth":[]}]},"patch":{"operationId":"signal_updateSignalCustomCategory","summary":"Update custom category","description":"Update a custom category. Supplying `scenarios` replaces the existing example phrases and re-triggers embedding.","tags":["signal"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Category updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalCustomCategoryResponse"}}}},"404":{"description":"Category not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalError"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalCustomCategoryUpdateRequest"}}}},"security":[{"BearerAuth":[]}]}},"/signal/settings":{"patch":{"operationId":"signal_updateSignalSettings","summary":"Update team settings","description":"Update team-level Signal preferences.","tags":["signal"],"responses":{"200":{"description":"Updated settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalSettingsResponse"}}}},"422":{"description":"No team context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalSettingsUpdateRequest"}}}},"security":[{"BearerAuth":[]}]}},"/secure_uploads":{"post":{"operationId":"secureUploads_createSecureUpload","summary":"Upload media securely","description":"Upload a media file and receive a short-lived token that can be passed to\ndownstream endpoints (such as `/detect` and `/intelligence`) in place of a\npublic URL. The returned token is a JWT that expires 1 hour after issuance.\n\nKeeping uploads private avoids exposing source media on the open internet and\nmeans you do not need to host files yourself for jobs that only need the API\nto read them once.\n","tags":["secureUploads"],"responses":{"200":{"description":"Upload accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Secure_Uploads_createSecureUpload_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The media file to upload (audio, image, or video)."}},"required":["file"]}}}},"security":[{"BearerAuth":[]}]}},"/synthesize":{"post":{"operationId":"textToSpeech_synthesize","summary":"Synchronous text-to-speech synthesis","description":"Generate speech synchronously from text or SSML. Returns complete audio as base64. The model associated with the voice is selected automatically.","tags":["textToSpeech"],"responses":{"200":{"description":"Successful synthesis","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Text-to-Speech_synthesize_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"voice_uuid":{"type":"string","description":"Voice UUID to use for synthesis"},"project_uuid":{"type":"string","description":"Optional project UUID to store the clip"},"title":{"type":"string","description":"Optional title for the generated clip"},"data":{"type":"string","description":"Text or SSML to synthesize (max 3,000 characters)"},"precision":{"$ref":"#/components/schemas/SynthesizePostRequestBodyContentApplicationJsonSchemaPrecision","description":"Audio precision for WAV output"},"output_format":{"$ref":"#/components/schemas/SynthesizePostRequestBodyContentApplicationJsonSchemaOutputFormat","description":"Audio output format"},"sample_rate":{"$ref":"#/components/schemas/SynthesizePostRequestBodyContentApplicationJsonSchemaSampleRate","description":"Audio sample rate in Hz"},"use_hd":{"type":"boolean","default":false,"description":"Enable HD synthesis with small latency trade-off"},"apply_custom_pronunciations":{"type":"boolean","default":false,"description":"When true, automatically applies your team's custom pronunciations to matching words in the input text. Defaults to false."}},"required":["voice_uuid","data"]}}}},"security":[{"BearerAuth":[]}]}},"/stream":{"post":{"operationId":"textToSpeech_streamSynthesize","summary":"Streaming text-to-speech synthesis (HTTP)","description":"Stream audio as it's generated. Returns chunked WAV data for progressive playback. The model associated with the voice is selected automatically.","tags":["textToSpeech"],"responses":{"200":{"description":"Streaming audio response (chunked WAV)","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"voice_uuid":{"type":"string","description":"Voice UUID to use for synthesis"},"data":{"type":"string","description":"Text or SSML to synthesize (max 2000 characters)"},"project_uuid":{"type":"string","description":"Optional project UUID to store the clip"},"precision":{"$ref":"#/components/schemas/StreamPostRequestBodyContentApplicationJsonSchemaPrecision","description":"Audio precision"},"sample_rate":{"$ref":"#/components/schemas/StreamPostRequestBodyContentApplicationJsonSchemaSampleRate","description":"Audio sample rate in Hz"},"use_hd":{"type":"boolean","default":false,"description":"Enable HD synthesis with small latency trade-off"},"apply_custom_pronunciations":{"type":"boolean","default":false,"description":"When true, automatically applies your team's custom pronunciations to matching words in the input text. Defaults to false."}},"required":["voice_uuid","data"]}}}},"security":[{"BearerAuth":[]}]}},"/speech-to-text":{"get":{"operationId":"speechToText_listTranscripts","summary":"List transcripts","description":"Retrieve paginated list of transcript jobs","tags":["speechToText"],"parameters":[{"name":"page","in":"query","required":true,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":25}}],"responses":{"200":{"description":"List of transcripts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Speech-to-Text_listTranscripts_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"speechToText_createTranscript","summary":"Create transcript job","description":"Submit audio or video for transcription","tags":["speechToText"],"responses":{"200":{"description":"Transcript job created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Speech-to-Text_createTranscript_Response_200"}}}},"400":{"description":"Bad request (missing input, invalid callback_url, or zero retention requested without a callback_url)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Zero retention is not included in the team's plan or subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"Audio or video file (max 500 MB, 20 minutes)"},"query":{"type":"string","description":"Optional intelligence question to evaluate after transcription"},"callback_url":{"type":"string","format":"uri","description":"Public HTTPS URL that receives a POST with the result when processing finishes. Private, loopback, link-local, and non-HTTPS URLs are rejected. Required when zero_retention_mode is true."},"zero_retention_mode":{"type":"boolean","default":false,"description":"Enable zero retention. The uploaded media and any temporary processing copies are permanently deleted after transcription, and the transcript content is purged after one delivery to callback_url (which is mandatory in this mode). privacy_mode is accepted as an alias. Plan feature — requests are rejected with 402 if not included in your plan."}}}}}},"security":[{"BearerAuth":[]}]}},"/speech-to-text/{uuid}":{"get":{"operationId":"speechToText_getTranscript","summary":"Get transcript","description":"Retrieve transcript status, text, and timestamps","tags":["speechToText"],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Transcript details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Speech-to-Text_getTranscript_Response_200"}}}}},"security":[{"BearerAuth":[]}]}},"/speech-to-text/{uuid}/ask":{"post":{"operationId":"speechToText_askTranscriptQuestion","summary":"Ask intelligence question","description":"Submit a question about a completed transcript","tags":["speechToText"],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Question submitted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Speech-to-Text_askTranscriptQuestion_Response_200"}}}},"400":{"description":"Missing query, transcript not yet processed, or the transcript was created with zero retention and its content has been purged","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"Question to ask about the transcript"}},"required":["query"]}}}},"security":[{"BearerAuth":[]}]}},"/speech-to-text/{uuid}/questions":{"get":{"operationId":"speechToText_listTranscriptQuestions","summary":"List intelligence questions","description":"List all questions asked about a transcript","tags":["speechToText"],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","maximum":50,"default":25}}],"responses":{"200":{"description":"List of questions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Speech-to-Text_listTranscriptQuestions_Response_200"}}}}},"security":[{"BearerAuth":[]}]}},"/speech-to-text/{uuid}/questions/{question_uuid}":{"get":{"operationId":"speechToText_getTranscriptQuestion","summary":"Get intelligence question status","description":"Check the status of a specific question","tags":["speechToText"],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"question_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Question details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Speech-to-Text_getTranscriptQuestion_Response_200"}}}}},"security":[{"BearerAuth":[]}]}},"/audio_enhancements":{"get":{"operationId":"audioEnhancement_listAudioEnhancements","summary":"List audio enhancements","description":"Returns a paginated list of all audio enhancements for your team, ordered by most recent first.","tags":["audioEnhancement"],"parameters":[{"name":"page","in":"query","description":"Page number (starting from 1).","required":true,"schema":{"type":"integer","minimum":1}},{"name":"page_size","in":"query","description":"Items per page (10 to 1000). Default 10.","required":false,"schema":{"type":"integer","minimum":10,"maximum":1000,"default":10}}],"responses":{"200":{"description":"List of enhancements","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audio_Enhancement_listAudioEnhancements_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAudioEnhancementsRequestBadRequestError"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"audioEnhancement_createAudioEnhancement","summary":"Create audio enhancement","description":"Submit an audio file for enhancement. Processing happens asynchronously in the background.\n","tags":["audioEnhancement"],"responses":{"202":{"description":"Enhancement job created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audio_Enhancement_createAudioEnhancement_Response_202"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAudioEnhancementRequestBadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAudioEnhancementRequestForbiddenError"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"audio_file":{"type":"string","format":"binary","description":"Audio file to enhance (WAV, MP3, M4A, MP4, OGG, AAC, FLAC). Max 150 MB."},"remove_noise":{"type":"boolean","default":true,"description":"Remove background noise."},"normalize":{"type":"boolean","default":true,"description":"Normalize audio levels."},"studio_sound":{"type":"boolean","default":true,"description":"Apply studio-quality enhancement."}},"required":["audio_file"]}}}},"security":[{"BearerAuth":[]}]}},"/audio_enhancements/{enhancement_uuid}":{"get":{"operationId":"audioEnhancement_getAudioEnhancement","summary":"Get audio enhancement","description":"Poll this endpoint to check the status of an enhancement job and retrieve the download URL when complete.","tags":["audioEnhancement"],"parameters":[{"name":"enhancement_uuid","in":"path","description":"The UUID returned from the create endpoint.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Enhancement details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audio_Enhancement_getAudioEnhancement_Response_200"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAudioEnhancementRequestNotFoundError"}}}}},"security":[{"BearerAuth":[]}]}},"/voices":{"get":{"operationId":"voices_listVoices","summary":"List voices","description":"Retrieve voice metadata","tags":["voices"],"parameters":[{"name":"page","in":"query","required":true,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","minimum":10,"maximum":1000,"default":10}},{"name":"advanced","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"List of voices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Voices_listVoices_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"voices_createVoice","summary":"Create voice","description":"Create a new voice","tags":["voices"],"responses":{"200":{"description":"Voice created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Voices_createVoice_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"dataset_url":{"type":"string","format":"uri"},"callback_uri":{"type":"string","format":"uri"},"language":{"type":"string","default":"en-US"}},"required":["name"]}}}},"security":[{"BearerAuth":[]}]}},"/voices/{voice_uuid}":{"get":{"operationId":"voices_getVoice","summary":"Get voice","description":"Get voice details","tags":["voices"],"parameters":[{"name":"voice_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Voice details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Voices_getVoice_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"operationId":"voices_deleteVoice","summary":"Delete voice","description":"Delete a voice","tags":["voices"],"parameters":[{"name":"voice_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Voice deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Voices_deleteVoice_Response_200"}}}}},"security":[{"BearerAuth":[]}]}},"/voices/{voice_uuid}/build":{"post":{"operationId":"voices_buildVoice","summary":"Build voice","description":"Start voice training","tags":["voices"],"parameters":[{"name":"voice_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Build started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Voices_buildVoice_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fill":{"type":"boolean","default":false}}}}}},"security":[{"BearerAuth":[]}]}},"/voices/{voice_uuid}/recordings":{"get":{"operationId":"recordings_listRecordings","summary":"List recordings","description":"List all recordings for a voice","tags":["recordings"],"parameters":[{"name":"voice_uuid","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"List of recordings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recordings_listRecordings_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"recordings_createRecording","summary":"Create recording","description":"Upload a new recording for voice training","tags":["recordings"],"parameters":[{"name":"voice_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Recording created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recordings_createRecording_Response_200"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"Audio file (WAV recommended, 1-12 seconds)"},"name":{"type":"string","description":"Display name"},"text":{"type":"string","description":"Transcript of the clip"},"emotion":{"type":"string","description":"Emotion label"},"is_active":{"type":"boolean","description":"Include in training"},"fill":{"type":"boolean","description":"Include for Resemble Fill"}},"required":["file","name","text","emotion","is_active"]}}}},"security":[{"BearerAuth":[]}]}},"/voices/{voice_uuid}/recordings/{recording_id}":{"get":{"operationId":"recordings_getRecording","summary":"Get recording","description":"Get recording details","tags":["recordings"],"parameters":[{"name":"voice_uuid","in":"path","required":true,"schema":{"type":"string"}},{"name":"recording_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Recording details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recordings_getRecording_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"operationId":"recordings_deleteRecording","summary":"Delete recording","description":"Delete a recording","tags":["recordings"],"parameters":[{"name":"voice_uuid","in":"path","required":true,"schema":{"type":"string"}},{"name":"recording_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Recording deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recordings_deleteRecording_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"patch":{"operationId":"recordings_updateRecording","summary":"Update recording","description":"Update a recording","tags":["recordings"],"parameters":[{"name":"voice_uuid","in":"path","required":true,"schema":{"type":"string"}},{"name":"recording_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Recording updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recordings_updateRecording_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"text":{"type":"string"},"emotion":{"type":"string"},"is_active":{"type":"boolean"}}}}}},"security":[{"BearerAuth":[]}]}},"/term_substitutions":{"get":{"operationId":"termSubstitutions_listTermSubstitutions","summary":"List term substitutions","description":"List all term substitutions","tags":["termSubstitutions"],"parameters":[{"name":"page","in":"query","required":true,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"List of term substitutions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Term_Substitutions_listTermSubstitutions_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"termSubstitutions_createTermSubstitution","summary":"Create term substitution","description":"Create a new pronunciation substitution","tags":["termSubstitutions"],"responses":{"200":{"description":"Term substitution created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Term_Substitutions_createTermSubstitution_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"original_text":{"type":"string","description":"Original text to substitute"},"replacement_text":{"type":"string","description":"Replacement pronunciation"}},"required":["original_text","replacement_text"]}}}},"security":[{"BearerAuth":[]}]}},"/term_substitutions/{id}":{"get":{"operationId":"termSubstitutions_getTermSubstitution","summary":"Get term substitution","description":"Get term substitution details","tags":["termSubstitutions"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Term substitution details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Term_Substitutions_getTermSubstitution_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"operationId":"termSubstitutions_deleteTermSubstitution","summary":"Delete term substitution","description":"Delete a term substitution","tags":["termSubstitutions"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Term substitution deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Term_Substitutions_deleteTermSubstitution_Response_200"}}}}},"security":[{"BearerAuth":[]}]}},"/pronunciations":{"get":{"operationId":"customPronunciations_listPronunciations","summary":"List custom pronunciations","description":"Retrieve all custom pronunciations for your team, with optional filters.","tags":["customPronunciations"],"parameters":[{"name":"language","in":"query","description":"Filter by language (e.g., en-us)","required":false,"schema":{"type":"string"}},{"name":"domain","in":"query","description":"Filter by domain (e.g., medical)","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter by processing status","required":false,"schema":{"$ref":"#/components/schemas/PronunciationsGetParametersStatus"}},{"name":"active","in":"query","description":"Filter by active state","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"List of custom pronunciations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Custom_Pronunciations_listPronunciations_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"customPronunciations_createPronunciation","summary":"Create custom pronunciation","description":"Upload a single pronunciation with a reference audio file.","tags":["customPronunciations"],"responses":{"201":{"description":"Pronunciation created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Custom_Pronunciations_createPronunciation_Response_201"}}}},"422":{"description":"Validation error (e.g., duplicate word)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"word":{"type":"string","description":"The word or phrase (2-100 characters). Letters, accented characters, apostrophes, hyphens, and spaces only."},"audio":{"type":"string","format":"binary","description":"Reference audio file (wav, flac, mp3, m4a, ogg, webm, aac). Duration 200ms-10s. Max 10MB."}},"required":["word","audio"]}}}},"security":[{"BearerAuth":[]}]}},"/pronunciations/bulk":{"post":{"operationId":"customPronunciations_bulkCreatePronunciations","summary":"Bulk create pronunciations from ZIP","description":"Upload multiple pronunciations at once. Each audio file in the ZIP becomes a pronunciation — the filename (without extension) is used as the word.","tags":["customPronunciations"],"responses":{"201":{"description":"Bulk creation result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Custom_Pronunciations_bulkCreatePronunciations_Response_201"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"zip":{"type":"string","format":"binary","description":"ZIP file containing audio files. Max 50 files, max 100MB total."}},"required":["zip"]}}}},"security":[{"BearerAuth":[]}]}},"/pronunciations/{uuid}":{"get":{"operationId":"customPronunciations_getPronunciation","summary":"Get custom pronunciation","description":"Retrieve a single custom pronunciation by UUID","tags":["customPronunciations"],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Pronunciation details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Custom_Pronunciations_getPronunciation_Response_200"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"operationId":"customPronunciations_deletePronunciation","summary":"Delete custom pronunciation","description":"Permanently remove a custom pronunciation. Takes effect immediately.","tags":["customPronunciations"],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Pronunciation deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Custom_Pronunciations_deletePronunciation_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"patch":{"operationId":"customPronunciations_updatePronunciation","summary":"Toggle pronunciation active status","description":"Enable or disable a pronunciation without deleting it. Inactive pronunciations are not used during synthesis.","tags":["customPronunciations"],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Pronunciation updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Custom_Pronunciations_updatePronunciation_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"active":{"type":"boolean","description":"Set to false to disable, true to re-enable"}},"required":["active"]}}}},"security":[{"BearerAuth":[]}]}},"/voice_settings_presets":{"get":{"operationId":"voiceSettingsPresets_listVoiceSettingsPresets","summary":"List voice settings presets","description":"List all voice settings presets","tags":["voiceSettingsPresets"],"responses":{"200":{"description":"List of presets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Voice_Settings_Presets_listVoiceSettingsPresets_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"voiceSettingsPresets_createVoiceSettingsPreset","summary":"Create voice settings preset","description":"Create a new voice settings preset (max 5 per user)","tags":["voiceSettingsPresets"],"responses":{"201":{"description":"Preset created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Voice_Settings_Presets_createVoiceSettingsPreset_Response_201"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":30,"description":"Preset name (unique, max 30 characters)"},"pace":{"type":"number","format":"double","minimum":0.2,"maximum":2,"default":1,"description":"Speech pace/speed"},"temperature":{"type":"number","format":"double","minimum":0.1,"maximum":5,"default":0.8,"description":"Voice variation"},"pitch":{"type":"number","format":"double","minimum":-10,"maximum":10,"default":0,"description":"Voice pitch adjustment"},"useHd":{"type":"boolean","default":false,"description":"Use HD quality"},"exaggeration":{"type":"number","format":"double","minimum":0,"maximum":1,"default":0.5,"description":"Emotional exaggeration"},"description":{"type":"string","maxLength":1000,"default":"","description":"Voice style prompt"}},"required":["name"]}}}},"security":[{"BearerAuth":[]}]}},"/voice_settings_presets/{uuid}":{"get":{"operationId":"voiceSettingsPresets_getVoiceSettingsPreset","summary":"Get voice settings preset","description":"Get preset details","tags":["voiceSettingsPresets"],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Preset details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Voice_Settings_Presets_getVoiceSettingsPreset_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"operationId":"voiceSettingsPresets_deleteVoiceSettingsPreset","summary":"Delete voice settings preset","description":"Delete a preset","tags":["voiceSettingsPresets"],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Preset deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Voice_Settings_Presets_deleteVoiceSettingsPreset_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"patch":{"operationId":"voiceSettingsPresets_updateVoiceSettingsPreset","summary":"Update voice settings preset","description":"Update a preset","tags":["voiceSettingsPresets"],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Preset updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Voice_Settings_Presets_updateVoiceSettingsPreset_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"pace":{"type":"number","format":"double"},"temperature":{"type":"number","format":"double"},"pitch":{"type":"number","format":"double"},"useHd":{"type":"boolean"},"exaggeration":{"type":"number","format":"double"},"description":{"type":"string"}}}}}},"security":[{"BearerAuth":[]}]}},"/projects":{"get":{"operationId":"projects_listProjects","summary":"List projects","description":"List all projects","tags":["projects"],"parameters":[{"name":"page","in":"query","required":true,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"List of projects","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Projects_listProjects_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"projects_createProject","summary":"Create project","description":"Create a new project","tags":["projects"],"responses":{"200":{"description":"Project created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Projects_createProject_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"is_collaborative":{"type":"boolean"},"is_archived":{"type":"boolean"}},"required":["name","description","is_collaborative","is_archived"]}}}},"security":[{"BearerAuth":[]}]}},"/projects/{project_uuid}":{"get":{"operationId":"projects_getProject","summary":"Get project","description":"Get project details","tags":["projects"],"parameters":[{"name":"project_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Projects_getProject_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"put":{"operationId":"projects_updateProject","summary":"Update project","description":"Update a project","tags":["projects"],"parameters":[{"name":"project_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Projects_updateProject_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"is_collaborative":{"type":"boolean"},"is_archived":{"type":"boolean"}}}}}},"security":[{"BearerAuth":[]}]},"delete":{"operationId":"projects_deleteProject","summary":"Delete project","description":"Delete a project","tags":["projects"],"parameters":[{"name":"project_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Projects_deleteProject_Response_200"}}}}},"security":[{"BearerAuth":[]}]}},"/projects/{project_uuid}/clips":{"get":{"operationId":"clips_listClips","summary":"List clips","description":"List clips in a project","tags":["clips"],"parameters":[{"name":"project_uuid","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"List of clips","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Clips_listClips_Response_200"}}}}},"security":[{"BearerAuth":[]}]}},"/projects/{project_uuid}/clips/{clip_uuid}":{"get":{"operationId":"clips_getClip","summary":"Get clip","description":"Get clip details","tags":["clips"],"parameters":[{"name":"project_uuid","in":"path","required":true,"schema":{"type":"string"}},{"name":"clip_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Clip details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Clips_getClip_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"operationId":"clips_deleteClip","summary":"Delete clip","description":"Delete a clip","tags":["clips"],"parameters":[{"name":"project_uuid","in":"path","required":true,"schema":{"type":"string"}},{"name":"clip_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Clip deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Clips_deleteClip_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"patch":{"operationId":"clips_updateClip","summary":"Update clip","description":"Update a clip","tags":["clips"],"parameters":[{"name":"project_uuid","in":"path","required":true,"schema":{"type":"string"}},{"name":"clip_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Clip updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Clips_updateClip_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"body":{"type":"string"},"is_archived":{"type":"boolean"}}}}}},"security":[{"BearerAuth":[]}]}},"/duet_voices":{"get":{"operationId":"duets_listDuetVoices","summary":"List duet voices","description":"Returns default and custom duet voices","tags":["duets"],"responses":{"200":{"description":"List of duet voices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Duets_listDuetVoices_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"duets_createDuetVoice","summary":"Create custom duet voice","description":"Create a custom voice for duet generation","tags":["duets"],"responses":{"200":{"description":"Duet voice created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Duets_createDuetVoice_Response_200"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Voice name"},"style_prompt":{"type":"string","description":"Optional style prompt"},"audio":{"type":"string","format":"binary","description":"Audio file (MP3/WAV/M4A/OGG/AAC/FLAC max 10 MB)"}},"required":["name","audio"]}}}},"security":[{"BearerAuth":[]}]}},"/duet_voices/{id}":{"put":{"operationId":"duets_updateDuetVoice","summary":"Update duet voice","description":"Update a custom duet voice (default voices cannot be modified)","tags":["duets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Duet voice updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Duets_updateDuetVoice_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"style_prompt":{"type":"string"}}}}}},"security":[{"BearerAuth":[]}]},"delete":{"operationId":"duets_deleteDuetVoice","summary":"Delete duet voice","description":"Delete a custom duet voice (default voices cannot be deleted)","tags":["duets"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Duet voice deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Duets_deleteDuetVoice_Response_200"}}}}},"security":[{"BearerAuth":[]}]}},"/duet_voice_pairs":{"get":{"operationId":"duets_listDuetVoicePairs","summary":"List duet voice pairs","description":"List all voice pairs for duet generation","tags":["duets"],"responses":{"200":{"description":"List of voice pairs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Duets_listDuetVoicePairs_Response_200"}}}}},"security":[{"BearerAuth":[]}]},"post":{"operationId":"duets_createDuetVoicePair","summary":"Create duet voice pair","description":"Create a voice pair for duet generation","tags":["duets"],"responses":{"200":{"description":"Voice pair created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Duets_createDuetVoicePair_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"voice_1_id":{"type":"integer","description":"ID of first voice"},"voice_2_id":{"type":"integer","description":"ID of second voice"},"name":{"type":"string","description":"Optional pair name"}},"required":["voice_1_id","voice_2_id"]}}}},"security":[{"BearerAuth":[]}]}},"/duet":{"post":{"operationId":"duets_generateDuet","summary":"Generate duet","description":"Generate conversational audio with two speakers","tags":["duets"],"responses":{"200":{"description":"Duet generation job created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Duets_generateDuet_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"voice_pair_id":{"type":"integer","description":"Voice pair ID to use"},"script":{"type":"array","items":{"$ref":"#/components/schemas/DuetPostRequestBodyContentApplicationJsonSchemaScriptItems"}},"title":{"type":"string","description":"Optional title for the duet"},"callback_uri":{"type":"string","format":"uri","description":"Webhook URL for completion notification"}},"required":["voice_pair_id","script"]}}}},"security":[{"BearerAuth":[]}]}},"/account":{"get":{"operationId":"account_getAccount","summary":"Get account","description":"Get account information","tags":["account"],"responses":{"200":{"description":"Account details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account_getAccount_Response_200"}}}}},"security":[{"BearerAuth":[]}]}},"/account/teams":{"get":{"operationId":"account_getTeams","summary":"Get teams","description":"Get team information","tags":["account"],"responses":{"200":{"description":"Team information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account_getTeams_Response_200"}}}}},"security":[{"BearerAuth":[]}]}},"/account/teams/{team_uuid}":{"get":{"operationId":"account_getTeam","summary":"Get team","description":"Get specific team information","tags":["account"],"parameters":[{"name":"team_uuid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Team information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account_getTeam_Response_200"}}}}},"security":[{"BearerAuth":[]}]}},"/plans":{"get":{"operationId":"billingPlans_listBillingPlans","summary":"List billing plans","description":"Returns all active self-serve plans, their products, prices, and plan-specific quantity rules. This endpoint is public.","tags":["billingPlans"],"responses":{"200":{"description":"Active self-serve billing plans.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingPlansResponse"}}}},"500":{"description":"An unexpected billing error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}}}}},"/plans/{id}":{"get":{"operationId":"billingPlans_getBillingPlan","summary":"Get a billing plan","description":"Returns an active billing plan by slug, including its products, prices, and quantity rules. This endpoint is public.","tags":["billingPlans"],"parameters":[{"name":"id","in":"path","description":"Plan slug returned by the list-plans endpoint.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Billing plan details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingPlanResponse"}}}},"404":{"description":"The requested billing resource does not exist for the current team.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"500":{"description":"An unexpected billing error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}}}}},"/subscription":{"get":{"operationId":"billingSubscriptions_getBillingSubscription","summary":"Get the current subscription","description":"Returns the current team's active, past-due, or delinquent subscription. Returns a null subscription when no customer-visible subscription exists.","tags":["billingSubscriptions"],"responses":{"200":{"description":"Current subscription or null.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSubscriptionResponse"}}}},"401":{"description":"A valid API key was not provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"403":{"description":"The API key owner cannot manage billing, or the Billing API is unavailable for the customer's billing arrangement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingForbiddenError"}}}},"500":{"description":"An unexpected billing error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}}},"security":[{"BearerAuth":[]}]}},"/subscription/products":{"patch":{"operationId":"billingSubscriptions_updateBillingSubscriptionProducts","summary":"Update subscription product quantities","description":"Updates one or more adjustable subscription products atomically. Each `new_quantity` is the desired absolute total, not an increment. A product is adjustable when its category is `subscription` and its `plan_product.allow_additional_usage` value is true. Quantities must remain within the plan's minimum and maximum and cannot be reduced below `consumed_quantity`.","tags":["billingSubscriptions"],"responses":{"200":{"description":"Subscription with updated product quantities.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSubscriptionResponse"}}}},"400":{"description":"The request could not be parsed or contains invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"401":{"description":"A valid API key was not provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"402":{"description":"Additional customer authentication is required before the billing change can complete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingPaymentActionRequired"}}}},"403":{"description":"The API key owner cannot manage billing, or the Billing API is unavailable for the customer's billing arrangement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingForbiddenError"}}}},"404":{"description":"The requested billing resource does not exist for the current team.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"422":{"description":"The request was understood but violates a billing rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingSubscriptionProductsRequestUnprocessableEntityError"}}}},"500":{"description":"An unexpected billing error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingUpdateProductsRequest"}}}},"security":[{"BearerAuth":[]}]}},"/subscription/confirm_payment":{"post":{"operationId":"billingSubscriptions_confirmBillingSubscriptionPayment","summary":"Confirm a subscription payment","description":"Synchronizes the subscription after the customer completes the additional payment authentication requested by a quantity or plan change.","tags":["billingSubscriptions"],"responses":{"200":{"description":"Synchronized subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSubscriptionResponse"}}}},"400":{"description":"The request could not be parsed or contains invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"401":{"description":"A valid API key was not provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"403":{"description":"The API key owner cannot manage billing, or the Billing API is unavailable for the customer's billing arrangement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingForbiddenError"}}}},"404":{"description":"The requested billing resource does not exist for the current team.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"422":{"description":"The request was understood but violates a billing rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmBillingSubscriptionPaymentRequestUnprocessableEntityError"}}}},"500":{"description":"An unexpected billing error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingConfirmPaymentRequest"}}}},"security":[{"BearerAuth":[]}]}},"/subscription/change_plan":{"patch":{"operationId":"billingSubscriptions_changeBillingPlan","summary":"Change the current subscription plan","description":"Changes a self-serve subscription to another active plan with proration. Optional product quantities are absolute quantities on the destination plan.","tags":["billingSubscriptions"],"responses":{"200":{"description":"Subscription on the new plan.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSubscriptionResponse"}}}},"400":{"description":"The request could not be parsed or contains invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"401":{"description":"A valid API key was not provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"402":{"description":"Additional customer authentication is required before the billing change can complete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingPaymentActionRequired"}}}},"403":{"description":"The API key owner cannot manage billing, or the Billing API is unavailable for the customer's billing arrangement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingForbiddenError"}}}},"404":{"description":"The requested billing resource does not exist for the current team.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"422":{"description":"The request was understood but violates a billing rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeBillingPlanRequestUnprocessableEntityError"}}}},"500":{"description":"An unexpected billing error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingChangePlanRequest"}}}},"security":[{"BearerAuth":[]}]}},"/wallet":{"get":{"operationId":"billingWallet_getBillingWallet","summary":"Get the billing wallet","description":"Returns the current team's cash, promotional, total, and lifetime wallet balances.","tags":["billingWallet"],"responses":{"200":{"description":"Wallet balances and statistics.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingWalletResponse"}}}},"401":{"description":"A valid API key was not provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"403":{"description":"The API key owner cannot manage billing, or the Billing API is unavailable for the customer's billing arrangement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingForbiddenError"}}}},"500":{"description":"An unexpected billing error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}}},"security":[{"BearerAuth":[]}]}},"/wallet/transactions":{"get":{"operationId":"billingWallet_listBillingWalletTransactions","summary":"List wallet transactions","description":"Returns wallet transactions newest first. Use page and per_page for paginated results, or limit for an unpaginated recent subset.","tags":["billingWallet"],"parameters":[{"name":"limit","in":"query","description":"Return at most this many recent transactions. When present, pagination metadata is omitted.","required":false,"schema":{"type":"integer","minimum":1}},{"name":"page","in":"query","description":"Page number. Defaults to 1 and is ignored when limit is present.","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","description":"Results per page. Defaults to 10 and is capped at 100.","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":10}}],"responses":{"200":{"description":"Wallet transactions and optional pagination metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingTransactionsResponse"}}}},"400":{"description":"The request could not be parsed or contains invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"401":{"description":"A valid API key was not provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"403":{"description":"The API key owner cannot manage billing, or the Billing API is unavailable for the customer's billing arrangement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingForbiddenError"}}}},"500":{"description":"An unexpected billing error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}}},"security":[{"BearerAuth":[]}]}},"/wallet/transactions/export.csv":{"get":{"operationId":"billingWallet_exportBillingWalletTransactions","summary":"Export wallet transactions","description":"Downloads the current team's complete wallet transaction history as a CSV file, newest first.","tags":["billingWallet"],"responses":{"200":{"description":"Response with status 200","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"401":{"description":"A valid API key was not provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"403":{"description":"The API key owner cannot manage billing, or the Billing API is unavailable for the customer's billing arrangement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingForbiddenError"}}}},"500":{"description":"An unexpected billing error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}}},"security":[{"BearerAuth":[]}]}},"/wallet/auto_reload":{"get":{"operationId":"billingWallet_getBillingAutoReload","summary":"Get auto-reload settings","description":"Returns the current team's auto-reload configuration, whether a payment method is available, and the supported reload range.","tags":["billingWallet"],"responses":{"200":{"description":"Auto-reload configuration or null when it has not been configured.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingAutoReloadResponse"}}}},"401":{"description":"A valid API key was not provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"403":{"description":"The API key owner cannot manage billing, or the Billing API is unavailable for the customer's billing arrangement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingForbiddenError"}}}},"500":{"description":"An unexpected billing error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}}},"security":[{"BearerAuth":[]}]},"put":{"operationId":"billingWallet_updateBillingAutoReload","summary":"Update auto-reload settings","description":"Enables, disables, or changes wallet auto-reload. Amounts are expressed in cents and must comply with the limits returned by the GET operation.","tags":["billingWallet"],"responses":{"200":{"description":"Updated auto-reload configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing_Wallet_updateBillingAutoReload_Response_200"}}}},"400":{"description":"The request could not be parsed or contains invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"401":{"description":"A valid API key was not provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}},"403":{"description":"The API key owner cannot manage billing, or the Billing API is unavailable for the customer's billing arrangement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingForbiddenError"}}}},"422":{"description":"The request was understood but violates a billing rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingAutoReloadRequestUnprocessableEntityError"}}}},"500":{"description":"An unexpected billing error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingUpdateAutoReloadRequest"}}}},"security":[{"BearerAuth":[]}]}}},"tags":[{"name":"deepfakeDetection"},{"name":"detectAgents"},{"name":"intelligence"},{"name":"detectIntelligence"},{"name":"audioSourceTracing"},{"name":"identity"},{"name":"watermark"},{"name":"textDetection"},{"name":"signal"},{"name":"secureUploads"},{"name":"textToSpeech"},{"name":"speechToText"},{"name":"audioEnhancement"},{"name":"voices"},{"name":"recordings"},{"name":"termSubstitutions"},{"name":"customPronunciations"},{"name":"voiceSettingsPresets"},{"name":"projects"},{"name":"clips"},{"name":"duets"},{"name":"account"},{"name":"billingPlans"},{"name":"billingSubscriptions"},{"name":"billingWallet"}],"servers":[{"url":"https://app.resemble.ai/api/v2","description":"production"},{"url":"https://f.cluster.resemble.ai","description":"synthesis"},{"url":"https://app.resemble.ai/billing/api/v1","description":"billing"}],"components":{"schemas":{"DetectGetResponsesContentApplicationJsonSchemaItemsItemsMediaType":{"type":"string","enum":["audio","video","image"],"title":"DetectGetResponsesContentApplicationJsonSchemaItemsItemsMediaType"},"DetectGetResponsesContentApplicationJsonSchemaItemsItemsStatus":{"type":"string","enum":["processing","completed","failed"],"description":"Processing state for the requested Detect work. For an otherwise successful Detect with watermark analysis, this remains processing until the linked analysis completes or fails. A core detection failure still reports failed.","title":"DetectGetResponsesContentApplicationJsonSchemaItemsItemsStatus"},"DetectGetResponsesContentApplicationJsonSchemaItemsItemsModality":{"type":"string","enum":["audio","video","all"],"description":"Which detection modality was requested. `all` when not specified (the default). Only meaningful for video detects.","title":"DetectGetResponsesContentApplicationJsonSchemaItemsItemsModality"},"DetectWatermarkAnalysisStatus":{"type":"string","enum":["pending","processing","completed","failed"],"description":"Lifecycle state of the linked watermark analysis.","title":"DetectWatermarkAnalysisStatus"},"WatermarkAudioDetectionMetricsOverallStatus":{"type":"string","enum":["present","absent","inconclusive"],"title":"WatermarkAudioDetectionMetricsOverallStatus"},"WatermarkAudioDetectionMetricsDetectedModelVersionsItems":{"type":"string","enum":["perth_v1","perth_v2"],"title":"WatermarkAudioDetectionMetricsDetectedModelVersionsItems"},"WatermarkAudioModelResultModelVersion":{"type":"string","enum":["perth_v1","perth_v2"],"title":"WatermarkAudioModelResultModelVersion"},"WatermarkAudioModelResultStatus":{"type":"string","enum":["succeeded","failed"],"title":"WatermarkAudioModelResultStatus"},"WatermarkAudioModelResult":{"type":"object","properties":{"model_version":{"$ref":"#/components/schemas/WatermarkAudioModelResultModelVersion"},"status":{"$ref":"#/components/schemas/WatermarkAudioModelResultStatus"},"detected":{"type":["boolean","null"],"description":"Null when this detector was unavailable."},"has_watermark":{"type":"object","additionalProperties":{"type":"boolean"},"description":"Successful per-channel detection results."},"confidence":{"type":["number","null"],"format":"double"},"error":{"type":"string","description":"Safe error message when status is failed."}},"required":["model_version","status","detected"],"title":"WatermarkAudioModelResult"},"WatermarkAudioDetectionMetrics":{"type":"object","properties":{"overall_status":{"$ref":"#/components/schemas/WatermarkAudioDetectionMetricsOverallStatus"},"detected_model_versions":{"type":"array","items":{"$ref":"#/components/schemas/WatermarkAudioDetectionMetricsDetectedModelVersionsItems"},"description":"Only model versions that positively detected a watermark."},"coverage_complete":{"type":"boolean","description":"True only when both audio detectors completed successfully."},"has_watermark":{"type":"object","additionalProperties":{"type":"boolean"},"description":"Per-channel aggregate across successful audio detectors."},"confidence":{"type":["number","null"],"format":"double"},"model_results":{"type":"array","items":{"$ref":"#/components/schemas/WatermarkAudioModelResult"}},"synthid":{"type":"boolean","description":"Optional auxiliary SynthID verdict for audio. Omitted when SynthID is unavailable."}},"required":["overall_status","detected_model_versions","coverage_complete","has_watermark","model_results"],"title":"WatermarkAudioDetectionMetrics"},"WatermarkVisionDetectionMetricsOverallStatus":{"type":"string","enum":["present","degraded","absent","inconclusive"],"title":"WatermarkVisionDetectionMetricsOverallStatus"},"WatermarkVisionDetectionMetricsDetectedModelVersionsItems":{"type":"string","enum":["perth_v2"],"title":"WatermarkVisionDetectionMetricsDetectedModelVersionsItems"},"WatermarkVisionModelResultModelVersion":{"type":"string","enum":["perth_v2"],"title":"WatermarkVisionModelResultModelVersion"},"WatermarkVisionModelResultStatus":{"type":"string","enum":["succeeded"],"title":"WatermarkVisionModelResultStatus"},"WatermarkVisionModelResult":{"type":"object","properties":{"model_version":{"$ref":"#/components/schemas/WatermarkVisionModelResultModelVersion"},"status":{"$ref":"#/components/schemas/WatermarkVisionModelResultStatus"},"detected":{"type":"boolean"},"confidence":{"type":["number","null"],"format":"double"}},"required":["model_version","status","detected"],"title":"WatermarkVisionModelResult"},"WatermarkVisionDetectionMetricsVerdict":{"type":"string","enum":["verified","degraded","not_watermarked"],"description":"Backward-compatible image/video verdict.","title":"WatermarkVisionDetectionMetricsVerdict"},"WatermarkVisionDetectionMetrics":{"type":"object","properties":{"overall_status":{"$ref":"#/components/schemas/WatermarkVisionDetectionMetricsOverallStatus"},"detected_model_versions":{"type":"array","items":{"$ref":"#/components/schemas/WatermarkVisionDetectionMetricsDetectedModelVersionsItems"},"description":"Contains perth_v2 only when watermark signal is detected."},"has_watermark":{"type":"boolean"},"detection_score":{"type":["number","null"],"format":"double"},"model_results":{"type":"array","items":{"$ref":"#/components/schemas/WatermarkVisionModelResult"}},"verdict":{"oneOf":[{"$ref":"#/components/schemas/WatermarkVisionDetectionMetricsVerdict"},{"type":"null"}],"description":"Backward-compatible image/video verdict."},"synthid":{"type":"boolean","description":"Optional auxiliary SynthID verdict for image or video. Omitted when SynthID is unavailable."}},"required":["overall_status","detected_model_versions","has_watermark","detection_score","model_results"],"title":"WatermarkVisionDetectionMetrics"},"DetectWatermarkAnalysisMetrics":{"oneOf":[{"$ref":"#/components/schemas/WatermarkAudioDetectionMetrics"},{"$ref":"#/components/schemas/WatermarkVisionDetectionMetrics"}],"description":"Present when watermark analysis completes. Audio uses Perth v1/v2 metrics; image and video use the Resemble image/video detector metrics. `synthid`, when present, is the boolean verdict returned by SynthID. Its omission means the provider result was unavailable, not that no watermark was found.","title":"DetectWatermarkAnalysisMetrics"},"DetectWatermarkAnalysis":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/DetectWatermarkAnalysisStatus","description":"Lifecycle state of the linked watermark analysis."},"metrics":{"$ref":"#/components/schemas/DetectWatermarkAnalysisMetrics","description":"Present when watermark analysis completes. Audio uses Perth v1/v2 metrics; image and video use the Resemble image/video detector metrics. `synthid`, when present, is the boolean verdict returned by SynthID. Its omission means the provider result was unavailable, not that no watermark was found."},"error_message":{"type":"string","description":"Safe error message when the watermark analysis failed. A child failure does not fail an otherwise successful deepfake detection."}},"required":["status"],"description":"Conditional watermark analysis requested with `detect_watermark=true`. The object is omitted when watermark analysis was not requested. Resemble watermark metrics and the optional SynthID verdict are independent of the deepfake verdict.","title":"DetectWatermarkAnalysis"},"DetectAudioMetrics":{"type":"object","properties":{"label":{"type":"string","description":"Detection label (fake or real)"},"score":{"type":"array","items":{"type":"string"},"description":"Array of prediction scores per chunk"},"consistency":{"type":"string","description":"Consistency metric across chunks"},"aggregated_score":{"type":"string","description":"Overall aggregated detection score"},"image":{"type":"string","description":"URL to visualization heatmap image (if visualize=true)"}},"required":["label","score","consistency","aggregated_score"],"description":"Audio detection metrics (for audio and video media types)","title":"DetectAudioMetrics"},"DetectImageMetricsChildrenItems":{"type":"object","properties":{},"title":"DetectImageMetricsChildrenItems"},"DetectImageMetrics":{"type":"object","properties":{"type":{"type":"string","description":"Type of image analysis performed"},"label":{"type":"string","description":"Detection label (fake or real)"},"image":{"type":"string","description":"URL to visualization image"},"score":{"type":"number","format":"double","description":"Detection confidence score"},"children":{"type":"array","items":{"$ref":"#/components/schemas/DetectImageMetricsChildrenItems"},"description":"Nested analysis results (structure varies by pipeline)"}},"required":["type","label","image","score","children"],"description":"Image detection metrics (for image media type)","title":"DetectImageMetrics"},"DetectVideoMetricsChildrenItemsChildrenItemsChildrenItems":{"type":"object","properties":{"type":{"type":"string"},"conclusion":{"type":"string"},"score":{"type":"number","format":"double"},"certainty":{"type":"number","format":"double"},"certainty (%)":{"type":"string"}},"required":["type","conclusion","score","certainty","certainty (%)"],"title":"DetectVideoMetricsChildrenItemsChildrenItemsChildrenItems"},"DetectVideoMetricsChildrenItemsChildrenItems":{"type":"object","properties":{"type":{"type":"string"},"conclusion":{"type":"string"},"score":{"type":"number","format":"double"},"certainty":{"type":"number","format":"double"},"certainty (%)":{"type":"string"},"timestamp":{"type":"number","format":"double","description":"Timestamp in seconds"},"children":{"type":"array","items":{"$ref":"#/components/schemas/DetectVideoMetricsChildrenItemsChildrenItemsChildrenItems"},"description":"Segment-level detection results"}},"required":["type","conclusion","score","certainty","certainty (%)","timestamp","children"],"title":"DetectVideoMetricsChildrenItemsChildrenItems"},"DetectVideoMetricsChildrenItems":{"type":"object","properties":{"type":{"type":"string"},"conclusion":{"type":"string"},"score":{"type":"number","format":"double"},"certainty":{"type":"number","format":"double"},"certainty (%)":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/DetectVideoMetricsChildrenItemsChildrenItems"},"description":"Frame-level detection results"}},"required":["type","conclusion","score","certainty","certainty (%)","children"],"title":"DetectVideoMetricsChildrenItems"},"DetectVideoMetrics":{"type":"object","properties":{"label":{"type":"string","description":"Overall video detection label"},"score":{"type":"number","format":"double","description":"Overall detection score"},"certainty":{"type":"number","format":"double","description":"Overall certainty score"},"treeview":{"type":"string","description":"Optional tree visualization data"},"children":{"type":"array","items":{"$ref":"#/components/schemas/DetectVideoMetricsChildrenItems"},"description":"Hierarchical detection results across frames"}},"required":["label","score","certainty","children"],"description":"Video detection metrics (for video media type)","title":"DetectVideoMetrics"},"DetectC2PaManifestValidationState":{"type":"string","enum":["Valid","NotPresent","Unavailable"],"description":"Verification state. `NotPresent` means no embedded Content Credentials were found; `Unavailable` means verification could not complete.","title":"DetectC2PaManifestValidationState"},"DetectC2paManifest":{"type":"object","properties":{"validation_state":{"$ref":"#/components/schemas/DetectC2PaManifestValidationState","description":"Verification state. `NotPresent` means no embedded Content Credentials were found; `Unavailable` means verification could not complete."},"active_manifest":{"type":["string","null"],"description":"Active C2PA manifest identifier when credentials are present"},"manifests":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Raw manifest details returned by C2PA tooling"},"validation_results":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Detailed validation results returned by C2PA tooling"},"message":{"type":["string","null"],"description":"Generic message when verification is unavailable"}},"description":"Content Credentials (C2PA) verification result for audio, image, and video media. Returned when verification has completed. A fallback verification failure returns `validation_state: Unavailable` and does not fail the detection.","title":"DetectC2paManifest"},"DetectGetResponsesContentApplicationJsonSchemaItemsItemsAudioSourceTracing":{"type":"object","properties":{"label":{"type":"string","description":"Identified source (e.g., resemble_ai, elevenlabs) or \"real\" if audio is not synthetic"},"error_message":{"type":["string","null"]}},"description":"Source tracing results (only returned if audio is labeled fake)","title":"DetectGetResponsesContentApplicationJsonSchemaItemsItemsAudioSourceTracing"},"DetectGetResponsesContentApplicationJsonSchemaItemsItemsIntelligence":{"type":"object","properties":{},"title":"DetectGetResponsesContentApplicationJsonSchemaItemsItemsIntelligence"},"DetectGetResponsesContentApplicationJsonSchemaItemsItemsExtraParams":{"type":"object","properties":{},"title":"DetectGetResponsesContentApplicationJsonSchemaItemsItemsExtraParams"},"DetectGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{"uuid":{"type":"string"},"media_type":{"$ref":"#/components/schemas/DetectGetResponsesContentApplicationJsonSchemaItemsItemsMediaType"},"status":{"$ref":"#/components/schemas/DetectGetResponsesContentApplicationJsonSchemaItemsItemsStatus","description":"Processing state for the requested Detect work. For an otherwise successful Detect with watermark analysis, this remains processing until the linked analysis completes or fails. A core detection failure still reports failed."},"modality":{"$ref":"#/components/schemas/DetectGetResponsesContentApplicationJsonSchemaItemsItemsModality","description":"Which detection modality was requested. `all` when not specified (the default). Only meaningful for video detects."},"face_only":{"type":"boolean","description":"Effective face-only setting for this detect. `true` only for video inputs that\ninclude visual analysis; `false` for audio, image, and audio-only video detects.\n"},"watermark":{"$ref":"#/components/schemas/DetectWatermarkAnalysis"},"metrics":{"$ref":"#/components/schemas/DetectAudioMetrics"},"image_metrics":{"$ref":"#/components/schemas/DetectImageMetrics"},"video_metrics":{"$ref":"#/components/schemas/DetectVideoMetrics"},"c2pa_manifest":{"$ref":"#/components/schemas/DetectC2paManifest"},"audio_source_tracing":{"oneOf":[{"$ref":"#/components/schemas/DetectGetResponsesContentApplicationJsonSchemaItemsItemsAudioSourceTracing"},{"type":"null"}],"description":"Source tracing results (only returned if audio is labeled fake)"},"intelligence":{"oneOf":[{"$ref":"#/components/schemas/DetectGetResponsesContentApplicationJsonSchemaItemsItemsIntelligence"},{"type":"null"}]},"url":{"type":["string","null"],"description":"URL to the media file. Null when Zero Retention Mode is enabled."},"audio_url":{"type":["string","null"],"description":"Alias of url. Null when Zero Retention Mode is enabled."},"filename":{"type":"string","description":"Original filename, or tokenized (redacted_<token>.<ext>) when Zero Retention Mode is enabled"},"duration":{"type":"number","format":"double"},"zero_retention_mode":{"type":"boolean","description":"Whether Zero Retention Mode was enabled for this detect"},"file_deleted_at":{"type":["string","null"],"format":"date-time","description":"ISO 8601 timestamp of when the file was purged, or null if not yet deleted"},"visualize":{"type":"boolean"},"audio_source_tracing_enabled":{"type":"boolean"},"use_ood_detector":{"type":"boolean"},"pipeline":{"type":["string","null"],"description":"Legacy field. May be present on older image/video detects. Ignored on create for new detections.","deprecated":true},"extra_params":{"$ref":"#/components/schemas/DetectGetResponsesContentApplicationJsonSchemaItemsItemsExtraParams"},"error_message":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"title":"DetectGetResponsesContentApplicationJsonSchemaItemsItems"},"Deepfake_Detection_listDetections_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"page":{"type":"integer"},"num_pages":{"type":"integer"},"page_size":{"type":"integer"},"total_count":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/DetectGetResponsesContentApplicationJsonSchemaItemsItems"}}},"title":"Deepfake Detection_listDetections_Response_200"},"DetectPostRequestBodyContentMultipartFormDataSchemaModality":{"type":"string","enum":["audio","video","all"],"default":"all","description":"Video only. Selects which detection components run for a video file:\n`audio` (audio track only), `video` (visual frames only), or `all` (both — the default).\nIgnored for audio and image inputs. Invalid values are rejected with HTTP 400.\n","title":"DetectPostRequestBodyContentMultipartFormDataSchemaModality"},"DetectPostResponsesContentApplicationJsonSchemaItemStatus":{"type":"string","enum":["processing","completed","failed"],"description":"Processing state for the requested Detect work. For an otherwise successful Detect with watermark analysis, this remains processing until the linked analysis completes or fails. A core detection failure still reports failed.","title":"DetectPostResponsesContentApplicationJsonSchemaItemStatus"},"DetectPostResponsesContentApplicationJsonSchemaItemModality":{"type":"string","enum":["audio","video","all"],"description":"Which detection modality was requested. `all` when not specified.\nFor a single-modality video detect, the skipped component's metrics are absent\n(`metrics` for audio-only-skipped, `video_metrics` for video-only-skipped), and the\ndetect still reaches `completed` once the requested modality(ies) finish.\n","title":"DetectPostResponsesContentApplicationJsonSchemaItemModality"},"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceStatus":{"type":"string","enum":["processing","completed","failed"],"title":"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceStatus"},"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1FraudType":{"type":"string","enum":["none","vishing","impersonation","romance_scam","tech_support_scam","financial_fraud","extortion","political_manipulation","synthetic_media_fraud","insurance_fraud","employment_fraud","other"],"title":"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1FraudType"},"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Fraud":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1FraudType"},"confidence":{"type":"number","format":"double","minimum":0,"maximum":100},"reasoning":{"type":"string"}},"title":"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Fraud"},"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1LivenessAssessment":{"type":"string","enum":["real_person","not_real_person","inconclusive"],"title":"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1LivenessAssessment"},"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Liveness":{"type":"object","properties":{"assessment":{"$ref":"#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1LivenessAssessment"},"confidence":{"type":"number","format":"double","minimum":0,"maximum":100},"indicators":{"type":"string"}},"title":"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Liveness"},"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1DigitallyAltered":{"type":"object","properties":{"detected":{"type":"boolean"},"confidence":{"type":"number","format":"double","minimum":0,"maximum":100},"alterations":{"type":"string"}},"title":"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1DigitallyAltered"},"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescription1":{"type":"object","properties":{"speaker_info":{"type":"string"},"language":{"type":"string"},"dialect":{"type":"string"},"emotion":{"type":"string"},"speaking_style":{"type":"string"},"context":{"type":"string"},"message":{"type":"string"},"abnormalities":{"type":"string"},"transcription":{"type":"string"},"translation":{"type":["string","null"]},"misinformation":{"type":"string"},"fraud":{"$ref":"#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Fraud"},"liveness":{"$ref":"#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Liveness"},"digitally_altered":{"$ref":"#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1DigitallyAltered"}},"title":"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescription1"},"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescription":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescription1"}],"title":"DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescription"},"DetectPostResponsesContentApplicationJsonSchemaItemIntelligence":{"type":"object","properties":{"uuid":{"type":"string"},"status":{"$ref":"#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceStatus"},"error_message":{"type":["string","null"]},"description":{"$ref":"#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescription"},"created_at":{"type":"string","format":"date-time"},"detect_uuid":{"type":"string"}},"description":"Default Intelligence result when requested","title":"DetectPostResponsesContentApplicationJsonSchemaItemIntelligence"},"DetectPostResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{"uuid":{"type":"string"},"status":{"$ref":"#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemStatus","description":"Processing state for the requested Detect work. For an otherwise successful Detect with watermark analysis, this remains processing until the linked analysis completes or fails. A core detection failure still reports failed."},"zero_retention_mode":{"type":"boolean","description":"Whether Zero Retention Mode is enabled for this detect"},"file_deleted_at":{"type":["string","null"],"format":"date-time","description":"ISO 8601 timestamp of when the file was purged, or null if not yet deleted"},"url":{"type":["string","null"],"description":"URL to the media file. Null when Zero Retention Mode is enabled."},"audio_url":{"type":["string","null"],"description":"Alias of url. Null when Zero Retention Mode is enabled."},"filename":{"type":"string","description":"Original filename, or tokenized (redacted_<token>.<ext>) when Zero Retention Mode is enabled"},"modality":{"$ref":"#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemModality","description":"Which detection modality was requested. `all` when not specified.\nFor a single-modality video detect, the skipped component's metrics are absent\n(`metrics` for audio-only-skipped, `video_metrics` for video-only-skipped), and the\ndetect still reaches `completed` once the requested modality(ies) finish.\n"},"face_only":{"type":"boolean","description":"Effective face-only setting. `true` only for video inputs that include visual\nanalysis; `false` for audio, image, and audio-only video detects.\n"},"watermark":{"$ref":"#/components/schemas/DetectWatermarkAnalysis"},"intelligence":{"oneOf":[{"$ref":"#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligence"},{"type":"null"}],"description":"Default Intelligence result when requested"},"c2pa_manifest":{"$ref":"#/components/schemas/DetectC2paManifest"}},"title":"DetectPostResponsesContentApplicationJsonSchemaItem"},"Deepfake_Detection_createDetection_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItem"}},"title":"Deepfake Detection_createDetection_Response_200"},"Error":{"type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"message":{"type":"string"}},"title":"Error"},"DetectPostResponsesContentApplicationJsonSchemaDetails":{"type":"object","properties":{"estimated_cost_cents":{"type":"number","format":"double"},"detect_cost_cents":{"type":"number","format":"double"},"watermark_cost_cents":{"type":"number","format":"double","description":"Present only when `detect_watermark=true` was requested."}},"title":"DetectPostResponsesContentApplicationJsonSchemaDetails"},"CreateDetectionRequestPaymentRequiredError":{"type":"object","properties":{"success":{"type":"boolean"},"error_code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"details":{"$ref":"#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaDetails"}},"title":"CreateDetectionRequestPaymentRequiredError"},"DetectUuidGetResponsesContentApplicationJsonSchemaItemMediaType":{"type":"string","enum":["audio","video","image"],"title":"DetectUuidGetResponsesContentApplicationJsonSchemaItemMediaType"},"DetectUuidGetResponsesContentApplicationJsonSchemaItemStatus":{"type":"string","enum":["processing","completed","failed"],"description":"Status of the requested Deepfake Detection work. For an otherwise successful Detect with watermark analysis, processing continues until that nested analysis completes or fails. A core detection failure still reports failed. A failed watermark analysis is terminal and does not fail an otherwise successful deepfake detection. Intelligence may still be processing after Detect reaches completed.","title":"DetectUuidGetResponsesContentApplicationJsonSchemaItemStatus"},"DetectUuidGetResponsesContentApplicationJsonSchemaItemAudioSourceTracing":{"type":"object","properties":{"label":{"type":"string","description":"Identified source (e.g., resemble_ai, elevenlabs) or \"real\" if audio is not synthetic"},"error_message":{"type":["string","null"]}},"description":"Source tracing results (only returned if audio is labeled fake)","title":"DetectUuidGetResponsesContentApplicationJsonSchemaItemAudioSourceTracing"},"DetectIntelligenceResultStatus":{"type":"string","enum":["processing","completed","failed"],"description":"Status of this Intelligence result, independent of the associated Detect job status.","title":"DetectIntelligenceResultStatus"},"DetectIntelligenceResultDescriptionOneOf1FraudType":{"type":"string","enum":["none","vishing","impersonation","romance_scam","tech_support_scam","financial_fraud","extortion","political_manipulation","synthetic_media_fraud","insurance_fraud","employment_fraud","other"],"title":"DetectIntelligenceResultDescriptionOneOf1FraudType"},"DetectIntelligenceResultDescriptionOneOf1Fraud":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DetectIntelligenceResultDescriptionOneOf1FraudType"},"confidence":{"type":"number","format":"double","minimum":0,"maximum":100},"reasoning":{"type":"string"}},"title":"DetectIntelligenceResultDescriptionOneOf1Fraud"},"DetectIntelligenceResultDescriptionOneOf1LivenessAssessment":{"type":"string","enum":["real_person","not_real_person","inconclusive"],"title":"DetectIntelligenceResultDescriptionOneOf1LivenessAssessment"},"DetectIntelligenceResultDescriptionOneOf1Liveness":{"type":"object","properties":{"assessment":{"$ref":"#/components/schemas/DetectIntelligenceResultDescriptionOneOf1LivenessAssessment"},"confidence":{"type":"number","format":"double","minimum":0,"maximum":100},"indicators":{"type":"string"}},"title":"DetectIntelligenceResultDescriptionOneOf1Liveness"},"DetectIntelligenceResultDescriptionOneOf1DigitallyAltered":{"type":"object","properties":{"detected":{"type":"boolean"},"confidence":{"type":"number","format":"double","minimum":0,"maximum":100},"alterations":{"type":"string"}},"title":"DetectIntelligenceResultDescriptionOneOf1DigitallyAltered"},"DetectIntelligenceResultDescription1":{"type":"object","properties":{"speaker_info":{"type":"string"},"language":{"type":"string"},"dialect":{"type":"string"},"emotion":{"type":"string"},"speaking_style":{"type":"string"},"context":{"type":"string"},"message":{"type":"string"},"abnormalities":{"type":"string"},"transcription":{"type":"string"},"translation":{"type":["string","null"]},"misinformation":{"type":"string"},"fraud":{"$ref":"#/components/schemas/DetectIntelligenceResultDescriptionOneOf1Fraud"},"liveness":{"$ref":"#/components/schemas/DetectIntelligenceResultDescriptionOneOf1Liveness"},"digitally_altered":{"$ref":"#/components/schemas/DetectIntelligenceResultDescriptionOneOf1DigitallyAltered"}},"title":"DetectIntelligenceResultDescription1"},"DetectIntelligenceResultDescription":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/DetectIntelligenceResultDescription1"}],"title":"DetectIntelligenceResultDescription"},"DetectIntelligenceResult":{"type":"object","properties":{"uuid":{"type":"string"},"status":{"$ref":"#/components/schemas/DetectIntelligenceResultStatus","description":"Status of this Intelligence result, independent of the associated Detect job status."},"error_message":{"type":["string","null"]},"description":{"oneOf":[{"$ref":"#/components/schemas/DetectIntelligenceResultDescription"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"detect_uuid":{"type":"string"}},"description":"One Detect Intelligence expert result","title":"DetectIntelligenceResult"},"DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligence1":{"type":"array","items":{"$ref":"#/components/schemas/DetectIntelligenceResult"},"title":"DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligence1"},"DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligence":{"oneOf":[{"$ref":"#/components/schemas/DetectIntelligenceResult"},{"$ref":"#/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligence1"}],"description":"With experts omitted or false, one completed Intelligence result when available; otherwise, the current processing or failed result. With experts=true, all successfully completed results as an array, or an empty array when none have completed successfully.","title":"DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligence"},"DetectUuidGetResponsesContentApplicationJsonSchemaItemModality":{"type":"string","enum":["audio","video","all"],"description":"Which detection modality was requested for this detect. `all` when not specified\n(the default). For a single-modality video detect, the skipped component's metrics\nare absent (`metrics` for audio-only-skipped, `video_metrics` for video-only-skipped).\n","title":"DetectUuidGetResponsesContentApplicationJsonSchemaItemModality"},"DetectUuidGetResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{"uuid":{"type":"string"},"media_type":{"$ref":"#/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemMediaType"},"status":{"$ref":"#/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemStatus","description":"Status of the requested Deepfake Detection work. For an otherwise successful Detect with watermark analysis, processing continues until that nested analysis completes or fails. A core detection failure still reports failed. A failed watermark analysis is terminal and does not fail an otherwise successful deepfake detection. Intelligence may still be processing after Detect reaches completed."},"metrics":{"$ref":"#/components/schemas/DetectAudioMetrics"},"image_metrics":{"$ref":"#/components/schemas/DetectImageMetrics"},"video_metrics":{"$ref":"#/components/schemas/DetectVideoMetrics"},"c2pa_manifest":{"$ref":"#/components/schemas/DetectC2paManifest"},"audio_source_tracing":{"oneOf":[{"$ref":"#/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemAudioSourceTracing"},{"type":"null"}],"description":"Source tracing results (only returned if audio is labeled fake)"},"intelligence":{"oneOf":[{"$ref":"#/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligence"},{"type":"null"}],"description":"With experts omitted or false, one completed Intelligence result when available; otherwise, the current processing or failed result. With experts=true, all successfully completed results as an array, or an empty array when none have completed successfully."},"modality":{"$ref":"#/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemModality","description":"Which detection modality was requested for this detect. `all` when not specified\n(the default). For a single-modality video detect, the skipped component's metrics\nare absent (`metrics` for audio-only-skipped, `video_metrics` for video-only-skipped).\n"},"face_only":{"type":"boolean","description":"Effective face-only setting for this detect. `true` only for video inputs that\ninclude visual analysis; `false` for audio, image, and audio-only video detects.\n"},"watermark":{"$ref":"#/components/schemas/DetectWatermarkAnalysis"},"url":{"type":["string","null"],"description":"URL to the media file. Null when Zero Retention Mode is enabled."},"audio_url":{"type":["string","null"],"description":"Alias of url. Null when Zero Retention Mode is enabled."},"filename":{"type":"string","description":"Original filename, or tokenized (redacted_<token>.<ext>) when Zero Retention Mode is enabled"},"duration":{"type":"number","format":"double"},"zero_retention_mode":{"type":"boolean","description":"Whether Zero Retention Mode is enabled for this detect"},"file_deleted_at":{"type":["string","null"],"format":"date-time","description":"ISO 8601 timestamp of when the file was purged, or null if not yet deleted"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"title":"DetectUuidGetResponsesContentApplicationJsonSchemaItem"},"Deepfake_Detection_getDetection_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItem"}},"title":"Deepfake Detection_getDetection_Response_200"},"Deepfake_Detection_deleteDetection_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"title":"Deepfake Detection_deleteDetection_Response_200"},"DetectBatchStatus":{"type":"string","enum":["processing","completed","partially_failed","failed"],"description":"Aggregate status across all child detects.\n  - `processing` — at least one child detect is still running.\n  - `completed` — every child detect completed successfully.\n  - `partially_failed` — at least one succeeded and at least one failed.\n  - `failed` — every child detect failed.\n","title":"DetectBatchStatus"},"DetectBatch":{"type":"object","properties":{"uuid":{"type":"string","description":"Batch UUID."},"status":{"$ref":"#/components/schemas/DetectBatchStatus","description":"Aggregate status across all child detects.\n  - `processing` — at least one child detect is still running.\n  - `completed` — every child detect completed successfully.\n  - `partially_failed` — at least one succeeded and at least one failed.\n  - `failed` — every child detect failed.\n"},"total_files":{"type":"integer","description":"Number of files in the batch (1–50)."},"completed_count":{"type":"integer","description":"Number of child detects that have completed successfully."},"failed_count":{"type":"integer","description":"Number of child detects that have failed."},"created_at":{"type":"string","format":"date-time"},"detect_uuids":{"type":"array","items":{"type":"string"},"description":"UUIDs of the child detects. Use `GET /detect/{uuid}` to retrieve per-file results."}},"description":"Aggregate state for a batch detection job. Returned by `POST /detect/batch` and `GET /detect/batch/{uuid}`.","title":"DetectBatch"},"Deepfake_Detection_createDetectBatch_Response_202":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/DetectBatch"}},"title":"Deepfake Detection_createDetectBatch_Response_202"},"Deepfake_Detection_getDetectBatch_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/DetectBatch"}},"title":"Deepfake Detection_getDetectBatch_Response_200"},"DetectFeedbackType":{"type":"string","enum":["correct","should_be_ai_generated","should_be_authentic","should_be_non_ai","should_be_neutral","skipped"],"description":"What the verdict should have been.","title":"DetectFeedbackType"},"DetectFeedbackVote":{"type":"string","enum":["up","down"],"description":"Derived from `type` — `correct` is `up`, everything else is `down`. Never independent of `type`.","title":"DetectFeedbackVote"},"DetectFeedbackVerdict":{"type":"string","enum":["ai_generated","authentic"],"description":"What the model said, snapshotted when the feedback was submitted. `null` when the\ndetection landed somewhere indeterminate. `should_be_neutral` and `should_be_non_ai`\nhave no counterpart here — this field records only the two decided model outcomes.\n","title":"DetectFeedbackVerdict"},"DetectFeedbackMediaType":{"type":"string","enum":["audio","video","image","text"],"description":"Media type of the detect.","title":"DetectFeedbackMediaType"},"DetectFeedback":{"type":"object","properties":{"detect_uuid":{"type":"string","description":"The detect this answer is attached to."},"type":{"$ref":"#/components/schemas/DetectFeedbackType","description":"What the verdict should have been."},"vote":{"$ref":"#/components/schemas/DetectFeedbackVote","description":"Derived from `type` — `correct` is `up`, everything else is `down`. Never independent of `type`."},"verdict":{"oneOf":[{"$ref":"#/components/schemas/DetectFeedbackVerdict"},{"type":"null"}],"description":"What the model said, snapshotted when the feedback was submitted. `null` when the\ndetection landed somewhere indeterminate. `should_be_neutral` and `should_be_non_ai`\nhave no counterpart here — this field records only the two decided model outcomes.\n"},"score":{"type":["number","null"],"format":"double","description":"The model's headline confidence, 0.0–1.0, or `null`. For video, the higher of the\naudio and video confidences.\n"},"media_type":{"$ref":"#/components/schemas/DetectFeedbackMediaType","description":"Media type of the detect."},"comment":{"type":["string","null"],"description":"The reviewer's free-text comment, or `null`."},"credit":{"type":"integer","description":"Credits awarded for this answer. Written by Resemble, never by the submitter; `0` on a fresh row."},"source":{"type":"string","description":"Attribution string recorded for this answer. Defaults to `api`."},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","description":"Moves when the answer is revised; `created_at` does not."}},"description":"A reviewer's answer about a detection verdict, stored with a snapshot of what the\nmodel said at the time the answer was submitted. Returned by\n`POST /detect/{uuid}/feedback` and `GET /detect/{uuid}/feedback`.\n","title":"DetectFeedback"},"Deepfake_Detection_getDetectFeedback_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/DetectFeedback"}},"title":"Deepfake Detection_getDetectFeedback_Response_200"},"DetectUuidFeedbackPostRequestBodyContentApplicationJsonSchemaType":{"type":"string","enum":["correct","should_be_ai_generated","should_be_authentic","should_be_non_ai","should_be_neutral","skipped"],"description":"What the verdict should have been.\n  - `correct` — the verdict was right.\n  - `should_be_ai_generated` — we said authentic; it is AI-generated.\n  - `should_be_authentic` — we said AI-generated; it is genuine and unaltered.\n  - `should_be_non_ai` — no model generated it, but it may still be edited, spliced, or a human impersonation.\n  - `should_be_neutral` — neither call is right; the media is genuinely ambiguous.\n  - `skipped` — the verdict was wrong, but the reviewer didn't say how.\n","title":"DetectUuidFeedbackPostRequestBodyContentApplicationJsonSchemaType"},"Deepfake_Detection_createDetectFeedback_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/DetectFeedback"}},"title":"Deepfake Detection_createDetectFeedback_Response_200"},"Deepfake_Detection_deleteDetectFeedback_Response_200":{"type":"object","properties":{"success":{"type":"boolean"}},"title":"Deepfake Detection_deleteDetectFeedback_Response_200"},"DetectAgentTier":{"type":"string","enum":["triage","investigation","forensic"],"description":"Managed investigation depth. Informational and read-only.","title":"DetectAgentTier"},"DetectAgentCapabilities":{"type":"object","properties":{"media":{"type":"boolean"},"reverse_search":{"type":"boolean"},"identity":{"type":"boolean"},"grounding":{"type":"boolean"},"structured":{"type":"boolean"},"tools":{"type":"boolean"},"knowledge":{"type":"boolean"}},"required":["media","reverse_search","identity","grounding","structured","tools","knowledge"],"description":"Read-only feature flags for a managed Detect Agent.","title":"DetectAgentCapabilities"},"DetectAgent":{"type":"object","properties":{"id":{"type":"string","description":"Stable Detect Agent identifier. Currently the same as `uuid` and `preset_id`."},"uuid":{"type":"string","description":"Stable identifier used by the run and history endpoints."},"preset_id":{"type":"string","description":"Resemble-managed Detect Agent identifier."},"name":{"type":"string"},"description":{"type":["string","null"],"description":"Verification workflow handled by the Detect Agent."},"tier":{"$ref":"#/components/schemas/DetectAgentTier","description":"Managed investigation depth. Informational and read-only."},"memory_preview":{"type":"string","description":"Read-only preview of patterns learned from previous investigations."},"capabilities":{"$ref":"#/components/schemas/DetectAgentCapabilities"},"tagline":{"type":["string","null"],"description":"Short description derived from the Detect Agent's managed instructions."},"activated":{"type":"boolean","description":"Whether this team has initialized backing state for the Detect Agent by running it."},"created_at":{"type":["string","null"],"format":"date-time","description":"Team backing-state creation time, or null before the first investigation."},"updated_at":{"type":["string","null"],"format":"date-time","description":"Team backing-state update time, or null before the first investigation."}},"required":["id","uuid","preset_id","name","tier","memory_preview","capabilities","activated"],"description":"A Resemble-managed Detect Agent available to the authenticated team.","title":"DetectAgent"},"Detect_Agents_listDetectAgents_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/DetectAgent"}},"count":{"type":"integer"}},"required":["success","items","count"],"title":"Detect Agents_listDetectAgents_Response_200"},"DetectAgentRunSummaryStatus":{"type":"string","enum":["running","completed","error"],"title":"DetectAgentRunSummaryStatus"},"DetectAgentRunResultVerdict":{"type":"object","properties":{"forced":{"type":"boolean"},"excerpt":{"type":"string"}},"title":"DetectAgentRunResultVerdict"},"DetectAgentRunResult":{"type":"object","properties":{"verdict":{"oneOf":[{"$ref":"#/components/schemas/DetectAgentRunResultVerdict"},{"type":"null"}]},"recommended_action":{"type":["string","null"]},"confidence":{"type":["number","null"],"format":"double"},"label":{"type":["string","null"]},"score":{"type":["number","null"],"format":"double"},"agent_ran":{"type":["boolean","null"]}},"description":"Compact result summary derived from the investigation transcript.","title":"DetectAgentRunResult"},"DetectAgentRunSummaryInputs":{"type":"object","properties":{"query":{"type":"string"},"url":{"type":"string","format":"uri"},"filename":{"type":"string"},"check_urls":{"type":"string"}},"description":"Submitted investigation inputs. Null-valued fields are omitted.","title":"DetectAgentRunSummaryInputs"},"DetectAgentRunSummary":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"Investigation run identifier."},"status":{"$ref":"#/components/schemas/DetectAgentRunSummaryStatus"},"result":{"$ref":"#/components/schemas/DetectAgentRunResult"},"inputs":{"$ref":"#/components/schemas/DetectAgentRunSummaryInputs","description":"Submitted investigation inputs. Null-valued fields are omitted."},"has_media":{"type":"boolean","description":"Whether primary uploaded media is attached to this run."},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["uuid","status","result","inputs","has_media"],"title":"DetectAgentRunSummary"},"Detect_Agents_listDetectAgentInvestigationRuns_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/DetectAgentRunSummary"}},"count":{"type":"integer","minimum":0,"maximum":100}},"required":["success","items","count"],"title":"Detect Agents_listDetectAgentInvestigationRuns_Response_200"},"DetectAgentRun":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"Investigation run identifier."},"status":{"$ref":"#/components/schemas/DetectAgentRunSummaryStatus"},"result":{"$ref":"#/components/schemas/DetectAgentRunResult"},"inputs":{"$ref":"#/components/schemas/DetectAgentRunSummaryInputs","description":"Submitted investigation inputs. Null-valued fields are omitted."},"has_media":{"type":"boolean","description":"Whether primary uploaded media is attached to this run."},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"transcript":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}},"description":"Public investigation events. Internal cost events are omitted."},"config_snapshot":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Exact managed configuration used for the investigation."},"memory_before":{"type":"string"},"memory_after":{"type":"string"},"error":{"type":["string","null"]},"media_url":{"type":["string","null"],"description":"Relative URL for uploaded primary media, or null when the run used a public URL."}},"required":["uuid","status","result","inputs","has_media"],"title":"DetectAgentRun"},"Detect_Agents_getDetectAgentInvestigationRun_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/DetectAgentRun"}},"required":["success","item"],"title":"Detect Agents_getDetectAgentInvestigationRun_Response_200"},"IntelligencePostRequestBodyContentApplicationJsonSchemaMediaType":{"type":"string","enum":["audio","video","image"],"description":"Explicit media type (auto-detected if not provided)","title":"IntelligencePostRequestBodyContentApplicationJsonSchemaMediaType"},"IntelligencePostResponsesContentApplicationJsonSchemaItemMediaType":{"type":"string","enum":["audio","video","image"],"description":"Type of media analyzed","title":"IntelligencePostResponsesContentApplicationJsonSchemaItemMediaType"},"IntelligencePostResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{"uuid":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"detect_uuid":{"type":"string","description":"UUID of the associated detect object"},"media_type":{"$ref":"#/components/schemas/IntelligencePostResponsesContentApplicationJsonSchemaItemMediaType","description":"Type of media analyzed"}},"title":"IntelligencePostResponsesContentApplicationJsonSchemaItem"},"Intelligence_runIntelligence_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/IntelligencePostResponsesContentApplicationJsonSchemaItem"}},"title":"Intelligence_runIntelligence_Response_200"},"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionFraudType":{"type":"string","enum":["none","vishing","impersonation","romance_scam","tech_support_scam","financial_fraud","extortion","political_manipulation","synthetic_media_fraud","insurance_fraud","employment_fraud","other"],"title":"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionFraudType"},"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionFraud":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionFraudType"},"confidence":{"type":"number","format":"double","minimum":0,"maximum":100},"reasoning":{"type":"string"}},"title":"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionFraud"},"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionLivenessAssessment":{"type":"string","enum":["real_person","not_real_person","inconclusive"],"title":"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionLivenessAssessment"},"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionLiveness":{"type":"object","properties":{"assessment":{"$ref":"#/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionLivenessAssessment"},"confidence":{"type":"number","format":"double","minimum":0,"maximum":100},"indicators":{"type":"string"}},"title":"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionLiveness"},"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionDigitallyAltered":{"type":"object","properties":{"detected":{"type":"boolean"},"confidence":{"type":"number","format":"double","minimum":0,"maximum":100},"alterations":{"type":"string"}},"title":"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionDigitallyAltered"},"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescription":{"type":"object","properties":{"speaker_info":{"type":"string"},"language":{"type":"string"},"dialect":{"type":"string"},"emotion":{"type":"string"},"speaking_style":{"type":"string"},"context":{"type":"string"},"message":{"type":"string"},"abnormalities":{"type":"string"},"transcription":{"type":"string"},"translation":{"type":["string","null"]},"misinformation":{"type":"string"},"fraud":{"$ref":"#/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionFraud"},"liveness":{"$ref":"#/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionLiveness"},"digitally_altered":{"$ref":"#/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionDigitallyAltered"}},"description":"Structured intelligence analysis","title":"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescription"},"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsMediaType":{"type":"string","enum":["audio","video","image"],"description":"Type of media analyzed","title":"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsMediaType"},"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{"uuid":{"type":"string"},"description":{"$ref":"#/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescription","description":"Structured intelligence analysis"},"created_at":{"type":"string","format":"date-time"},"detect_uuid":{"type":"string","description":"UUID of the associated detect object"},"media_type":{"$ref":"#/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsMediaType","description":"Type of media analyzed"}},"title":"IntelligencesGetResponsesContentApplicationJsonSchemaItemsItems"},"Intelligence_listIntelligences_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"page":{"type":"integer"},"num_pages":{"type":"integer"},"page_size":{"type":"integer"},"total_count":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItems"}}},"title":"Intelligence_listIntelligences_Response_200"},"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionFraudType":{"type":"string","enum":["none","vishing","impersonation","romance_scam","tech_support_scam","financial_fraud","extortion","political_manipulation","synthetic_media_fraud","insurance_fraud","employment_fraud","other"],"title":"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionFraudType"},"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionFraud":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionFraudType"},"confidence":{"type":"number","format":"double","minimum":0,"maximum":100},"reasoning":{"type":"string"}},"title":"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionFraud"},"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionLivenessAssessment":{"type":"string","enum":["real_person","not_real_person","inconclusive"],"title":"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionLivenessAssessment"},"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionLiveness":{"type":"object","properties":{"assessment":{"$ref":"#/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionLivenessAssessment"},"confidence":{"type":"number","format":"double","minimum":0,"maximum":100},"indicators":{"type":"string"}},"title":"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionLiveness"},"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionDigitallyAltered":{"type":"object","properties":{"detected":{"type":"boolean"},"confidence":{"type":"number","format":"double","minimum":0,"maximum":100},"alterations":{"type":"string"}},"title":"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionDigitallyAltered"},"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescription":{"type":"object","properties":{"speaker_info":{"type":"string"},"language":{"type":"string"},"dialect":{"type":"string"},"emotion":{"type":"string"},"speaking_style":{"type":"string"},"context":{"type":"string"},"message":{"type":"string"},"abnormalities":{"type":"string"},"transcription":{"type":"string"},"translation":{"type":["string","null"]},"misinformation":{"type":"string"},"fraud":{"$ref":"#/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionFraud"},"liveness":{"$ref":"#/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionLiveness"},"digitally_altered":{"$ref":"#/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionDigitallyAltered"}},"description":"Structured intelligence analysis","title":"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescription"},"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemMediaType":{"type":"string","enum":["audio","video","image"],"description":"Type of media analyzed","title":"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemMediaType"},"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{"uuid":{"type":"string"},"description":{"$ref":"#/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescription","description":"Structured intelligence analysis"},"created_at":{"type":"string","format":"date-time"},"detect_uuid":{"type":"string","description":"UUID of the associated detect object"},"media_type":{"$ref":"#/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemMediaType","description":"Type of media analyzed"}},"title":"IntelligencesUuidGetResponsesContentApplicationJsonSchemaItem"},"Intelligence_getIntelligence_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItem"}},"title":"Intelligence_getIntelligence_Response_200"},"DetectsUuidIntelligencePostResponsesContentApplicationJsonSchemaItemStatus":{"type":"string","enum":["pending","processing","completed","failed"],"description":"Current status of the question","title":"DetectsUuidIntelligencePostResponsesContentApplicationJsonSchemaItemStatus"},"DetectsUuidIntelligencePostResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID of the question"},"detect_uuid":{"type":"string","description":"UUID of the associated detection report"},"query":{"type":"string","description":"The submitted question"},"answer":{"type":["string","null"],"description":"The generated answer (null until completed)"},"status":{"$ref":"#/components/schemas/DetectsUuidIntelligencePostResponsesContentApplicationJsonSchemaItemStatus","description":"Current status of the question"},"error_message":{"type":["string","null"],"description":"Error details when status is failed"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"title":"DetectsUuidIntelligencePostResponsesContentApplicationJsonSchemaItem"},"Detect_Intelligence_askDetectIntelligenceQuestion_Response_202":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/DetectsUuidIntelligencePostResponsesContentApplicationJsonSchemaItem"}},"title":"Detect Intelligence_askDetectIntelligenceQuestion_Response_202"},"DetectsUuidIntelligenceQuestionUuidGetResponsesContentApplicationJsonSchemaItemStatus":{"type":"string","enum":["pending","processing","completed","failed"],"description":"Current status of the question","title":"DetectsUuidIntelligenceQuestionUuidGetResponsesContentApplicationJsonSchemaItemStatus"},"DetectsUuidIntelligenceQuestionUuidGetResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID of the question"},"detect_uuid":{"type":"string","description":"UUID of the associated detection report"},"query":{"type":"string","description":"The submitted question"},"answer":{"type":["string","null"],"description":"The generated answer (null until completed)"},"status":{"$ref":"#/components/schemas/DetectsUuidIntelligenceQuestionUuidGetResponsesContentApplicationJsonSchemaItemStatus","description":"Current status of the question"},"error_message":{"type":["string","null"],"description":"Error details when status is failed"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"title":"DetectsUuidIntelligenceQuestionUuidGetResponsesContentApplicationJsonSchemaItem"},"Detect_Intelligence_getDetectIntelligenceQuestion_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/DetectsUuidIntelligenceQuestionUuidGetResponsesContentApplicationJsonSchemaItem"}},"title":"Detect Intelligence_getDetectIntelligenceQuestion_Response_200"},"AudioSourceTracingsGetResponsesContentApplicationJsonSchemaItemsItemsResults":{"type":"object","properties":{"label":{"type":"string","description":"Identified source (e.g., resemble_ai, elevenlabs) or \"real\" if audio is not synthetic"},"error_message":{"type":["string","null"]}},"title":"AudioSourceTracingsGetResponsesContentApplicationJsonSchemaItemsItemsResults"},"AudioSourceTracingsGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{"uuid":{"type":"string"},"results":{"$ref":"#/components/schemas/AudioSourceTracingsGetResponsesContentApplicationJsonSchemaItemsItemsResults"},"created_at":{"type":"string","format":"date-time"},"detect_uuid":{"type":"string","description":"UUID of the associated detect object"}},"title":"AudioSourceTracingsGetResponsesContentApplicationJsonSchemaItemsItems"},"Audio_Source_Tracing_listAudioSourceTracings_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"page":{"type":"integer"},"num_pages":{"type":"integer"},"page_size":{"type":"integer"},"total_count":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AudioSourceTracingsGetResponsesContentApplicationJsonSchemaItemsItems"}}},"title":"Audio Source Tracing_listAudioSourceTracings_Response_200"},"AudioSourceTracingsUuidGetResponsesContentApplicationJsonSchemaItemResults":{"type":"object","properties":{"label":{"type":"string","description":"Identified source (e.g., resemble_ai, elevenlabs) or \"real\" if audio is not synthetic"},"error_message":{"type":["string","null"]}},"title":"AudioSourceTracingsUuidGetResponsesContentApplicationJsonSchemaItemResults"},"AudioSourceTracingsUuidGetResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{"uuid":{"type":"string"},"results":{"$ref":"#/components/schemas/AudioSourceTracingsUuidGetResponsesContentApplicationJsonSchemaItemResults"},"created_at":{"type":"string","format":"date-time"},"detect_uuid":{"type":"string","description":"UUID of the associated detect object"}},"title":"AudioSourceTracingsUuidGetResponsesContentApplicationJsonSchemaItem"},"Audio_Source_Tracing_getAudioSourceTracing_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/AudioSourceTracingsUuidGetResponsesContentApplicationJsonSchemaItem"}},"title":"Audio Source Tracing_getAudioSourceTracing_Response_200"},"IdentitySummaryVisibility":{"type":"string","enum":["team","global"],"title":"IdentitySummaryVisibility"},"IdentitySummaryIdentityType":{"type":"string","enum":["person","brand"],"title":"IdentitySummaryIdentityType"},"IdentitySummary":{"type":"object","properties":{"uuid":{"type":"string"},"name":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"audio_url":{"type":["string","null"],"format":"uri","description":"URL of the first voice sample, if any"},"visibility":{"$ref":"#/components/schemas/IdentitySummaryVisibility"},"identity_type":{"$ref":"#/components/schemas/IdentitySummaryIdentityType"},"notes":{"type":["string","null"]},"voice_profile_id":{"type":["string","null"]},"updated_at":{"type":"string","format":"date-time"},"project_count":{"type":"integer"}},"description":"Identity summary returned by the list and simple-create endpoints","title":"IdentitySummary"},"Identity_listIdentities_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"page":{"type":"integer"},"num_pages":{"type":"integer"},"page_size":{"type":"integer"},"total_count":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/IdentitySummary"}}},"title":"Identity_listIdentities_Response_200"},"IdentityCreateIdentityRequest0":{"type":"object","properties":{"name":{"type":"string","description":"Speaker name/identifier"},"url":{"type":"string","format":"uri","description":"URL to an audio sample (one of url, audio, signed_id is required)"},"signed_id":{"type":"string","description":"Signed ID from a secure upload"}},"required":["name"],"title":"IdentityCreateIdentityRequest0"},"IdentityPostRequestBodyContentApplicationJsonSchemaOneOf1IdentityIdentityType":{"type":"string","enum":["person","brand"],"default":"person","title":"IdentityPostRequestBodyContentApplicationJsonSchemaOneOf1IdentityIdentityType"},"IdentityPostRequestBodyContentApplicationJsonSchemaOneOf1IdentityVisibility":{"type":"string","enum":["team","global"],"default":"team","title":"IdentityPostRequestBodyContentApplicationJsonSchemaOneOf1IdentityVisibility"},"IdentityPostRequestBodyContentApplicationJsonSchemaOneOf1Identity":{"type":"object","properties":{"name":{"type":"string","maxLength":120},"identity_type":{"$ref":"#/components/schemas/IdentityPostRequestBodyContentApplicationJsonSchemaOneOf1IdentityIdentityType"},"visibility":{"$ref":"#/components/schemas/IdentityPostRequestBodyContentApplicationJsonSchemaOneOf1IdentityVisibility"},"notes":{"type":"string"},"voice_profile_id":{"type":"string"}},"required":["name"],"title":"IdentityPostRequestBodyContentApplicationJsonSchemaOneOf1Identity"},"IdentityCreateIdentityRequest1":{"type":"object","properties":{"identity":{"$ref":"#/components/schemas/IdentityPostRequestBodyContentApplicationJsonSchemaOneOf1Identity"}},"required":["identity"],"title":"IdentityCreateIdentityRequest1"},"Identity_createIdentity_Request":{"oneOf":[{"$ref":"#/components/schemas/IdentityCreateIdentityRequest0"},{"$ref":"#/components/schemas/IdentityCreateIdentityRequest1"}],"title":"Identity_createIdentity_Request"},"Identity_createIdentity_Response_200":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the voice was enrolled for matching immediately"},"item":{"$ref":"#/components/schemas/IdentitySummary"}},"title":"Identity_createIdentity_Response_200"},"Identity_deleteIdentity_Response_200":{"type":"object","properties":{"success":{"type":"boolean"}},"title":"Identity_deleteIdentity_Response_200"},"IdentityUuidAttachmentsPostRequestBodyContentMultipartFormDataSchemaModality":{"type":"string","enum":["voice","face","video"],"title":"IdentityUuidAttachmentsPostRequestBodyContentMultipartFormDataSchemaModality"},"IdentityIdentityType":{"type":"string","enum":["person","brand"],"title":"IdentityIdentityType"},"IdentityVisibility":{"type":"string","enum":["team","global"],"title":"IdentityVisibility"},"IdentityAttachment":{"type":"object","properties":{"id":{"type":"integer"},"filename":{"type":"string"},"byte_size":{"type":"integer"},"content_type":{"type":"string"}},"description":"A reference media file attached to an identity","title":"IdentityAttachment"},"IdentityEmbeddingsItemsModality":{"type":"string","enum":["voice","face","video"],"title":"IdentityEmbeddingsItemsModality"},"IdentityEmbeddingsItems":{"type":"object","properties":{"modality":{"$ref":"#/components/schemas/IdentityEmbeddingsItemsModality"},"status":{"type":"string"},"attachment_count":{"type":"integer"},"computed_at":{"type":["string","null"],"format":"date-time"}},"title":"IdentityEmbeddingsItems"},"IdentityProjectsItems":{"type":"object","properties":{"uuid":{"type":"string"},"name":{"type":"string"}},"title":"IdentityProjectsItems"},"Identity":{"type":"object","properties":{"uuid":{"type":"string"},"name":{"type":"string"},"identity_type":{"$ref":"#/components/schemas/IdentityIdentityType"},"visibility":{"$ref":"#/components/schemas/IdentityVisibility"},"notes":{"type":["string","null"]},"voice_profile_id":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"project_count":{"type":"integer"},"voice_samples":{"type":"array","items":{"$ref":"#/components/schemas/IdentityAttachment"}},"face_photos":{"type":"array","items":{"$ref":"#/components/schemas/IdentityAttachment"}},"reference_videos":{"type":"array","items":{"$ref":"#/components/schemas/IdentityAttachment"}},"embeddings":{"type":"array","items":{"$ref":"#/components/schemas/IdentityEmbeddingsItems"},"description":"Per-modality embedding processing status"},"projects":{"type":"array","items":{"$ref":"#/components/schemas/IdentityProjectsItems"}}},"description":"A multimodal identity profile","title":"Identity"},"Identity_deleteIdentityAttachment_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"Identity_deleteIdentityAttachment_Response_204"},"IdentitySearchPostRequestBodyContentApplicationJsonSchemaModality":{"type":"string","enum":["audio","image"],"description":"Inferred from the media's content type when omitted (defaults to audio)","title":"IdentitySearchPostRequestBodyContentApplicationJsonSchemaModality"},"IdentitySearchPostResponsesContentApplicationJsonSchemaModality":{"type":"string","enum":["audio","image"],"title":"IdentitySearchPostResponsesContentApplicationJsonSchemaModality"},"IdentitySearchPostResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{"name":{"type":"string"},"distance":{"type":"number","format":"double"},"score_type":{"type":"string"}},"title":"IdentitySearchPostResponsesContentApplicationJsonSchemaItem"},"Identity_searchIdentities_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"modality":{"$ref":"#/components/schemas/IdentitySearchPostResponsesContentApplicationJsonSchemaModality"},"item":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IdentitySearchPostResponsesContentApplicationJsonSchemaItem"},"description":"Matches keyed by identity UUID. distance is a 0-100 match score (higher is closer; an identical sample scores 100). Image matches include score_type \"cosine\".\n"}},"title":"Identity_searchIdentities_Response_200"},"WatermarkApplyPostParametersPrefer":{"type":"string","enum":["wait"],"title":"WatermarkApplyPostParametersPrefer"},"WatermarkApplyRequestOutputFormat":{"type":"string","enum":["default","source"],"default":"default","description":"`default` returns WAV (audio), PNG (image), or MP4 (video). `source` returns the source's format (for example JPEG, AVIF, M4A, or MOV) when it can be reproduced, otherwise the default.","title":"WatermarkApplyRequestOutputFormat"},"WatermarkApplyRequest":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Public HTTPS URL to the audio, image, or video source."},"output_format":{"$ref":"#/components/schemas/WatermarkApplyRequestOutputFormat","description":"`default` returns WAV (audio), PNG (image), or MP4 (video). `source` returns the source's format (for example JPEG, AVIF, M4A, or MOV) when it can be reproduced, otherwise the default."},"strength":{"type":"number","format":"double","minimum":0,"maximum":1,"default":0.2,"description":"Watermark strength for image/video. Ignored for audio."},"custom_message":{"type":"string","maxLength":64,"default":"resembleai","description":"Message to embed in image/video. Ignored for audio."}},"required":["url"],"title":"WatermarkApplyRequest"},"WatermarkApplyItemMediaType":{"type":"string","enum":["audio","image","video"],"description":"Detected media type of the source file.","title":"WatermarkApplyItemMediaType"},"WatermarkApplyItemOperationType":{"type":"string","enum":["apply"],"title":"WatermarkApplyItemOperationType"},"WatermarkApplyItemStatus":{"type":"string","enum":["pending","processing","completed","failed"],"title":"WatermarkApplyItemStatus"},"WatermarkApplyItemModelVersion":{"type":"string","enum":["perth_v2"],"title":"WatermarkApplyItemModelVersion"},"WatermarkApplyMetrics":{"type":"object","properties":{"strength":{"type":"number","format":"double"},"custom_message":{"type":"string"},"message_bits_length":{"type":["integer","null"]}},"description":"Apply metadata for image/video. Audio apply metrics are null.","title":"WatermarkApplyMetrics"},"WatermarkApplyItem":{"type":"object","properties":{"uuid":{"type":"string"},"media_type":{"$ref":"#/components/schemas/WatermarkApplyItemMediaType","description":"Detected media type of the source file."},"operation_type":{"$ref":"#/components/schemas/WatermarkApplyItemOperationType"},"status":{"$ref":"#/components/schemas/WatermarkApplyItemStatus"},"model_version":{"$ref":"#/components/schemas/WatermarkApplyItemModelVersion"},"source_media_url":{"type":"string","format":"uri"},"watermarked_media":{"type":["string","null"],"format":"uri","description":"Signed output URL when processing is complete. The file is WAV, PNG, or MP4 unless the request set `output_format` to `source`."},"metrics":{"$ref":"#/components/schemas/WatermarkApplyMetrics"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["uuid","media_type","operation_type","status","model_version","source_media_url","created_at","updated_at"],"title":"WatermarkApplyItem"},"WatermarkApplyResponse":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/WatermarkApplyItem"}},"required":["success","item"],"title":"WatermarkApplyResponse"},"WatermarkDetectPostParametersPrefer":{"type":"string","enum":["wait"],"title":"WatermarkDetectPostParametersPrefer"},"WatermarkDetectRequest":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Public HTTPS URL to the audio, image, or video source."},"custom_message":{"type":"string","maxLength":64,"default":"resembleai","description":"Message used when applying the image/video watermark. Ignored for audio."}},"required":["url"],"title":"WatermarkDetectRequest"},"WatermarkDetectItemMediaType":{"type":"string","enum":["audio","image","video"],"title":"WatermarkDetectItemMediaType"},"WatermarkDetectItemOperationType":{"type":"string","enum":["detect"],"title":"WatermarkDetectItemOperationType"},"WatermarkDetectItemStatus":{"type":"string","enum":["pending","processing","completed","failed"],"title":"WatermarkDetectItemStatus"},"WatermarkDetectItemModelVersion":{"type":"string","enum":["perth_v2"],"description":"Present for image/video. Audio versions are reported in metrics.model_results.","title":"WatermarkDetectItemModelVersion"},"WatermarkDetectItemMetrics":{"oneOf":[{"$ref":"#/components/schemas/WatermarkAudioDetectionMetrics"},{"$ref":"#/components/schemas/WatermarkVisionDetectionMetrics"}],"description":"Null while processing. New results use the media-specific versioned schema; historical audio results can use a flat shape.","title":"WatermarkDetectItemMetrics"},"WatermarkDetectItem":{"type":"object","properties":{"uuid":{"type":"string"},"media_type":{"$ref":"#/components/schemas/WatermarkDetectItemMediaType"},"operation_type":{"$ref":"#/components/schemas/WatermarkDetectItemOperationType"},"status":{"$ref":"#/components/schemas/WatermarkDetectItemStatus"},"model_version":{"$ref":"#/components/schemas/WatermarkDetectItemModelVersion","description":"Present for image/video. Audio versions are reported in metrics.model_results."},"source_media_url":{"type":"string","format":"uri"},"metrics":{"oneOf":[{"$ref":"#/components/schemas/WatermarkDetectItemMetrics"},{"type":"null"}],"description":"Null while processing. New results use the media-specific versioned schema; historical audio results can use a flat shape."},"watermarked_media":{"type":["string","null"],"format":"uri","description":"Detection does not produce output media."},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["uuid","media_type","operation_type","status","source_media_url","created_at","updated_at"],"title":"WatermarkDetectItem"},"WatermarkDetectResponse":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/WatermarkDetectItem"}},"required":["success","item"],"title":"WatermarkDetectResponse"},"TextDetectItemStatus":{"type":"string","enum":["processing","completed","failed"],"description":"`processing` until inference returns, `completed` once `prediction` and `confidence` are populated, or `failed` if the analysis errored.","title":"TextDetectItemStatus"},"TextDetectItemPrediction":{"type":"string","enum":["ai","human","uncertain"],"description":"Verdict for the passage. `uncertain` means the detector abstained rather than guessing (for example, too few words after normalization); abstained requests are not billed. Null while processing.","title":"TextDetectItemPrediction"},"TextDetectItem":{"type":"object","properties":{"uuid":{"type":"string"},"status":{"$ref":"#/components/schemas/TextDetectItemStatus","description":"`processing` until inference returns, `completed` once `prediction` and `confidence` are populated, or `failed` if the analysis errored."},"prediction":{"oneOf":[{"$ref":"#/components/schemas/TextDetectItemPrediction"},{"type":"null"}],"description":"Verdict for the passage. `uncertain` means the detector abstained rather than guessing (for example, too few words after normalization); abstained requests are not billed. Null while processing."},"confidence":{"type":["number","null"],"format":"double","description":"Confidence in the reported `prediction`, from 0 to 1. Null while processing."},"text_content":{"type":["string","null"],"description":"The submitted text."},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["uuid","status","created_at","updated_at"],"title":"TextDetectItem"},"TextDetectListResponse":{"type":"object","properties":{"success":{"type":"boolean"},"page":{"type":"integer"},"num_pages":{"type":"integer"},"page_size":{"type":"integer"},"total_count":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/TextDetectItem"}}},"required":["success","page","num_pages","page_size","total_count","items"],"title":"TextDetectListResponse"},"TextDetectPostParametersPrefer":{"type":"string","enum":["wait"],"title":"TextDetectPostParametersPrefer"},"TextDetectRequestThinking":{"type":"string","enum":["low","medium","high"],"default":"low","description":"How much reasoning effort the detector spends on the passage. Higher levels can improve accuracy on ambiguous text at the cost of latency.","title":"TextDetectRequestThinking"},"TextDetectRequest":{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":100000,"description":"The text to analyze. Must contain at least 25 words (whitespace-delimited) and at most 100,000 characters. Shorter passages are rejected with a 400 because no threshold reliably separates casual human writing from AI-generated text below that length."},"thinking":{"$ref":"#/components/schemas/TextDetectRequestThinking","description":"How much reasoning effort the detector spends on the passage. Higher levels can improve accuracy on ambiguous text at the cost of latency."},"threshold":{"type":"number","format":"double","description":"Probability cutoff used to turn the AI-likelihood score into the `ai` or `human` prediction. Scores at or above the threshold are reported as `ai`."},"callback_url":{"type":"string","format":"uri","description":"POST destination for the result once processing finishes. The body matches the response of `GET /text_detect/{uuid}` with an additional top-level `error` field when analysis failed."}},"required":["text"],"title":"TextDetectRequest"},"TextDetectResponse":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/TextDetectItem"}},"required":["success","item"],"title":"TextDetectResponse"},"SignalSubmissionInputModality":{"type":"string","enum":["text","audio","video","image"],"title":"SignalSubmissionInputModality"},"SignalSubmissionVerdict":{"type":"string","enum":["safe","suspicious","fraud"],"title":"SignalSubmissionVerdict"},"SignalCategoryScore":{"type":"object","properties":{"name":{"type":"string"},"icon":{"type":["string","null"],"description":"Single emoji associated with the category."},"score":{"type":"number","format":"double","description":"Similarity score from 0 to 1."}},"required":["name","score"],"title":"SignalCategoryScore"},"SignalScoreItemInputModality":{"type":"string","enum":["text","audio","video","image"],"title":"SignalScoreItemInputModality"},"SignalScoreItemVerdict":{"type":"string","enum":["safe","suspicious","fraud"],"title":"SignalScoreItemVerdict"},"SignalTopMatch":{"type":"object","properties":{"category":{"type":"string","description":"Category the matched example belongs to."},"text":{"type":"string","description":"The individual training example that matched."},"score":{"type":"number","format":"double"}},"title":"SignalTopMatch"},"SignalScoreItem":{"type":"object","properties":{"id":{"type":"integer","description":"Submission identifier, used with `DELETE /signal/{id}`."},"input_modality":{"$ref":"#/components/schemas/SignalScoreItemInputModality"},"verdict":{"$ref":"#/components/schemas/SignalScoreItemVerdict"},"top_category":{"$ref":"#/components/schemas/SignalCategoryScore"},"category_scores":{"type":"array","items":{"$ref":"#/components/schemas/SignalCategoryScore"},"description":"Highest-scoring categories, including the top category."},"benign_score":{"type":["number","null"],"format":"double","description":"How strongly the content matched benign, non-fraud content."},"margin_over_second":{"type":["number","null"],"format":"double","description":"Gap between the top category score and the runner-up."},"examples":{"type":"array","items":{"type":"string"},"description":"Sample phrases from the top category, useful for explaining the verdict."},"top_matches":{"type":"array","items":{"$ref":"#/components/schemas/SignalTopMatch"}},"duration_seconds":{"type":["number","null"],"format":"double","description":"Media duration for audio and video. Null for text and image."},"created_at":{"type":"string","format":"date-time"}},"required":["input_modality","verdict"],"title":"SignalScoreItem"},"SignalSubmission":{"type":"object","properties":{"id":{"type":"integer"},"input_modality":{"$ref":"#/components/schemas/SignalSubmissionInputModality"},"filename":{"type":["string","null"],"description":"Original filename for file submissions."},"content_type":{"type":["string","null"],"description":"MIME type for file submissions."},"text_preview":{"type":["string","null"],"description":"Truncated copy of the submitted text. Null for file submissions."},"verdict":{"$ref":"#/components/schemas/SignalSubmissionVerdict"},"top_category":{"$ref":"#/components/schemas/SignalCategoryScore"},"benign_score":{"type":["number","null"],"format":"double"},"margin_over_second":{"type":["number","null"],"format":"double"},"response":{"$ref":"#/components/schemas/SignalScoreItem"},"created_at":{"type":"string","format":"date-time"}},"title":"SignalSubmission"},"SignalSubmissionListResponse":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SignalSubmission"}},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"required":["success","items"],"title":"SignalSubmissionListResponse"},"SignalError":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"max_bytes":{"type":"integer","description":"Present on 413 responses."}},"title":"SignalError"},"SignalScoreResponse":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/SignalScoreItem"}},"required":["success","item"],"title":"SignalScoreResponse"},"SignalSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"],"title":"SignalSuccessResponse"},"SignalSettings":{"type":"object","properties":{"use_builtin_categories":{"type":"boolean","description":"When false, scoring uses only the team's custom categories."}},"title":"SignalSettings"},"SignalBuiltInCategory":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"icon":{"type":["string","null"]},"scenario_count":{"type":"integer"},"example_texts":{"type":"array","items":{"type":"string"}}},"title":"SignalBuiltInCategory"},"SignalCustomCategoryStatus":{"type":"string","enum":["pending","embedding","ready","needs_more_examples","failed"],"title":"SignalCustomCategoryStatus"},"SignalCustomCategoryOverlapsItems":{"type":"object","properties":{},"title":"SignalCustomCategoryOverlapsItems"},"SignalScenario":{"type":"object","properties":{"id":{"type":"integer"},"text":{"type":"string"},"embedded":{"type":"boolean","description":"Whether this example has finished embedding."}},"title":"SignalScenario"},"SignalCustomCategory":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":["string","null"]},"icon":{"type":["string","null"]},"enabled":{"type":"boolean","description":"Whether the category is included in scoring."},"status":{"$ref":"#/components/schemas/SignalCustomCategoryStatus"},"embed_error":{"type":["string","null"],"description":"Error message when `status` is `failed`."},"embedded_at":{"type":["string","null"],"format":"date-time"},"scenario_count":{"type":"integer"},"embedding_model_version":{"type":["string","null"]},"overlaps":{"type":"array","items":{"$ref":"#/components/schemas/SignalCustomCategoryOverlapsItems"},"description":"Calibration warnings where this category was confused with another."},"scenarios":{"type":"array","items":{"$ref":"#/components/schemas/SignalScenario"}}},"title":"SignalCustomCategory"},"SignalCalibrationWarningsItems":{"type":"object","properties":{},"title":"SignalCalibrationWarningsItems"},"SignalCalibration":{"type":"object","properties":{"status":{"type":"string"},"calibrated_at":{"type":["string","null"],"format":"date-time"},"overall_recall":{"type":["number","null"],"format":"double"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/SignalCalibrationWarningsItems"}}},"description":"Null until the team's categories have been calibrated.","title":"SignalCalibration"},"SignalCustomCategoryListResponse":{"type":"object","properties":{"success":{"type":"boolean"},"settings":{"$ref":"#/components/schemas/SignalSettings"},"built_in_categories":{"type":"array","items":{"$ref":"#/components/schemas/SignalBuiltInCategory"}},"custom_categories":{"type":"array","items":{"$ref":"#/components/schemas/SignalCustomCategory"}},"calibration":{"$ref":"#/components/schemas/SignalCalibration"}},"required":["success"],"title":"SignalCustomCategoryListResponse"},"SignalCustomCategoryCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"Category name. Must be unique within the team."},"scenarios":{"type":"array","items":{"type":"string"},"description":"Example phrases that define the pattern. Maximum 50 entries, each up to 2000 characters. A newline-separated string is also accepted."},"description":{"type":"string"},"icon":{"type":"string","description":"Single emoji."},"enabled":{"type":"boolean","default":true}},"required":["name","scenarios"],"title":"SignalCustomCategoryCreateRequest"},"SignalCustomCategoryResponse":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/SignalCustomCategory"}},"required":["success","item"],"title":"SignalCustomCategoryResponse"},"SignalCustomCategoryUpdateRequest":{"type":"object","properties":{"name":{"type":"string"},"scenarios":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"icon":{"type":"string"},"enabled":{"type":"boolean"}},"description":"Any subset of the create parameters. Supplying `scenarios` replaces the existing set and re-triggers embedding.","title":"SignalCustomCategoryUpdateRequest"},"SignalSettingsUpdateRequest":{"type":"object","properties":{"use_builtin_categories":{"type":"boolean","description":"When false, scoring uses only the team's custom categories."}},"title":"SignalSettingsUpdateRequest"},"SignalSettingsResponse":{"type":"object","properties":{"success":{"type":"boolean"},"settings":{"$ref":"#/components/schemas/SignalSettings"}},"required":["success","settings"],"title":"SignalSettingsResponse"},"Secure_Uploads_createSecureUpload_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"token":{"type":"string","description":"JWT referencing the uploaded file. Valid for 1 hour. Pass this value as `media_token` on downstream requests."}},"title":"Secure Uploads_createSecureUpload_Response_200"},"SynthesizePostRequestBodyContentApplicationJsonSchemaPrecision":{"type":"string","enum":["MULAW","PCM_16","PCM_24","PCM_32"],"default":"PCM_32","description":"Audio precision for WAV output","title":"SynthesizePostRequestBodyContentApplicationJsonSchemaPrecision"},"SynthesizePostRequestBodyContentApplicationJsonSchemaOutputFormat":{"type":"string","enum":["wav","mp3"],"default":"wav","description":"Audio output format","title":"SynthesizePostRequestBodyContentApplicationJsonSchemaOutputFormat"},"SynthesizePostRequestBodyContentApplicationJsonSchemaSampleRate":{"type":"string","enum":["8000","16000","22050","32000","44100","48000"],"description":"Audio sample rate in Hz","title":"SynthesizePostRequestBodyContentApplicationJsonSchemaSampleRate"},"AudioTimestamps":{"type":"object","properties":{"graph_chars":{"type":"array","items":{"type":"string"},"description":"Grapheme characters"},"graph_times":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}},"description":"Grapheme timestamps [start, end] in seconds"},"phon_chars":{"type":"array","items":{"type":"string"},"description":"Phoneme characters"},"phon_times":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}},"description":"Phoneme timestamps [start, end] in seconds"}},"title":"AudioTimestamps"},"Text-to-Speech_synthesize_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"audio_content":{"type":"string","format":"byte","description":"Base64-encoded audio bytes"},"audio_timestamps":{"$ref":"#/components/schemas/AudioTimestamps"},"duration":{"type":"number","format":"double","description":"Audio duration in seconds"},"synth_duration":{"type":"number","format":"double","description":"Raw synthesis time"},"output_format":{"type":"string"},"sample_rate":{"type":"integer"},"title":{"type":"string"},"issues":{"type":"array","items":{"type":"string"}}},"title":"Text-to-Speech_synthesize_Response_200"},"StreamPostRequestBodyContentApplicationJsonSchemaPrecision":{"type":"string","enum":["MULAW","PCM_16","PCM_24","PCM_32"],"default":"PCM_32","description":"Audio precision","title":"StreamPostRequestBodyContentApplicationJsonSchemaPrecision"},"StreamPostRequestBodyContentApplicationJsonSchemaSampleRate":{"type":"string","enum":["8000","16000","22050","32000","44100","48000"],"description":"Audio sample rate in Hz","title":"StreamPostRequestBodyContentApplicationJsonSchemaSampleRate"},"SpeechToTextGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"status":{"type":"string"},"duration_seconds":{"type":"number","format":"double"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"title":"SpeechToTextGetResponsesContentApplicationJsonSchemaItemsItems"},"SpeechToTextGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_items":{"type":"integer"}},"title":"SpeechToTextGetResponsesContentApplicationJsonSchemaMeta"},"Speech-to-Text_listTranscripts_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SpeechToTextGetResponsesContentApplicationJsonSchemaItemsItems"}},"meta":{"$ref":"#/components/schemas/SpeechToTextGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Speech-to-Text_listTranscripts_Response_200"},"SpeechToTextPostResponsesContentApplicationJsonSchemaItemStatus":{"type":"string","enum":["pending","processing","completed","failed"],"title":"SpeechToTextPostResponsesContentApplicationJsonSchemaItemStatus"},"SpeechToTextPostResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/SpeechToTextPostResponsesContentApplicationJsonSchemaItemStatus"},"privacy_mode":{"type":"boolean","description":"Whether the transcript was created with zero retention"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"title":"SpeechToTextPostResponsesContentApplicationJsonSchemaItem"},"Speech-to-Text_createTranscript_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/SpeechToTextPostResponsesContentApplicationJsonSchemaItem"}},"title":"Speech-to-Text_createTranscript_Response_200"},"SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItemStatus":{"type":"string","enum":["pending","processing","completed","failed"],"title":"SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItemStatus"},"SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItemWordsItems":{"type":"object","properties":{"text":{"type":"string"},"start_time":{"type":"number","format":"double"},"end_time":{"type":"number","format":"double"},"speaker_id":{"type":"string"}},"title":"SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItemWordsItems"},"SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItemStatus"},"text":{"type":"string","description":"Absent for zero-retention transcripts after the content purge"},"words":{"type":"array","items":{"$ref":"#/components/schemas/SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItemWordsItems"}},"duration_seconds":{"type":"number","format":"double"},"file_url":{"type":"string","format":"uri","description":"Absent once the media has been deleted (zero retention)"},"query":{"type":"string"},"answer":{"type":"string"},"privacy_mode":{"type":"boolean","description":"Whether the transcript was created with zero retention"},"file_deleted_at":{"type":"string","format":"date-time","description":"When the uploaded media was permanently deleted (zero retention)"},"content_deleted_at":{"type":"string","format":"date-time","description":"When the transcript content was permanently purged (zero retention)"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"title":"SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItem"},"Speech-to-Text_getTranscript_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItem"}},"title":"Speech-to-Text_getTranscript_Response_200"},"SpeechToTextUuidAskPostResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"transcript_uuid":{"type":"string","format":"uuid"},"query":{"type":"string"},"status":{"type":"string"},"created_at":{"type":"string","format":"date-time"}},"title":"SpeechToTextUuidAskPostResponsesContentApplicationJsonSchemaItem"},"Speech-to-Text_askTranscriptQuestion_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/SpeechToTextUuidAskPostResponsesContentApplicationJsonSchemaItem"}},"title":"Speech-to-Text_askTranscriptQuestion_Response_200"},"SpeechToTextUuidQuestionsGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"query":{"type":"string"},"answer":{"type":"string"},"status":{"type":"string"},"created_at":{"type":"string","format":"date-time"}},"title":"SpeechToTextUuidQuestionsGetResponsesContentApplicationJsonSchemaItemsItems"},"SpeechToTextUuidQuestionsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{},"title":"SpeechToTextUuidQuestionsGetResponsesContentApplicationJsonSchemaMeta"},"Speech-to-Text_listTranscriptQuestions_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SpeechToTextUuidQuestionsGetResponsesContentApplicationJsonSchemaItemsItems"}},"meta":{"$ref":"#/components/schemas/SpeechToTextUuidQuestionsGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Speech-to-Text_listTranscriptQuestions_Response_200"},"SpeechToTextUuidQuestionsQuestionUuidGetResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"transcript_uuid":{"type":"string","format":"uuid"},"query":{"type":"string"},"answer":{"type":"string"},"status":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"title":"SpeechToTextUuidQuestionsQuestionUuidGetResponsesContentApplicationJsonSchemaItem"},"Speech-to-Text_getTranscriptQuestion_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/SpeechToTextUuidQuestionsQuestionUuidGetResponsesContentApplicationJsonSchemaItem"}},"title":"Speech-to-Text_getTranscriptQuestion_Response_200"},"AudioEnhancementsGetResponsesContentApplicationJsonSchemaItemsItemsStatus":{"type":"string","enum":["pending","processing","completed","failed"],"title":"AudioEnhancementsGetResponsesContentApplicationJsonSchemaItemsItemsStatus"},"AudioEnhancementsGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{"uuid":{"type":"string"},"status":{"$ref":"#/components/schemas/AudioEnhancementsGetResponsesContentApplicationJsonSchemaItemsItemsStatus"},"error_message":{"type":["string","null"]},"remove_noise":{"type":"boolean","description":"Whether background noise removal was applied."},"normalize":{"type":"boolean","description":"Whether loudness normalization was applied."},"studio_sound":{"type":"boolean","description":"Whether studio-quality enhancement was applied."},"original_audio_url":{"type":"string","format":"uri"},"enhanced_audio_url":{"type":"string","format":"uri"}},"title":"AudioEnhancementsGetResponsesContentApplicationJsonSchemaItemsItems"},"Audio_Enhancement_listAudioEnhancements_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"page":{"type":"integer"},"num_pages":{"type":"integer"},"page_size":{"type":"integer"},"total_count":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AudioEnhancementsGetResponsesContentApplicationJsonSchemaItemsItems"}}},"title":"Audio Enhancement_listAudioEnhancements_Response_200"},"ListAudioEnhancementsRequestBadRequestError":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"title":"ListAudioEnhancementsRequestBadRequestError"},"AudioEnhancementsPostResponsesContentApplicationJsonSchemaStatus":{"type":"string","enum":["pending"],"title":"AudioEnhancementsPostResponsesContentApplicationJsonSchemaStatus"},"Audio_Enhancement_createAudioEnhancement_Response_202":{"type":"object","properties":{"success":{"type":"boolean"},"uuid":{"type":"string"},"status":{"$ref":"#/components/schemas/AudioEnhancementsPostResponsesContentApplicationJsonSchemaStatus"}},"title":"Audio Enhancement_createAudioEnhancement_Response_202"},"CreateAudioEnhancementRequestBadRequestError":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"title":"CreateAudioEnhancementRequestBadRequestError"},"CreateAudioEnhancementRequestForbiddenError":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"title":"CreateAudioEnhancementRequestForbiddenError"},"AudioEnhancementsEnhancementUuidGetResponsesContentApplicationJsonSchemaStatus":{"type":"string","enum":["pending","processing","completed","failed"],"title":"AudioEnhancementsEnhancementUuidGetResponsesContentApplicationJsonSchemaStatus"},"Audio_Enhancement_getAudioEnhancement_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"uuid":{"type":"string"},"status":{"$ref":"#/components/schemas/AudioEnhancementsEnhancementUuidGetResponsesContentApplicationJsonSchemaStatus"},"enhanced_audio_url":{"type":["string","null"],"format":"uri","description":"Download URL. Only present when status is completed. This is a temporary signed URL."},"error_message":{"type":["string","null"],"description":"Human-readable error. Only present when status is failed."}},"title":"Audio Enhancement_getAudioEnhancement_Response_200"},"GetAudioEnhancementRequestNotFoundError":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"title":"GetAudioEnhancementRequestNotFoundError"},"VoicesGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{},"title":"VoicesGetResponsesContentApplicationJsonSchemaItemsItems"},"Voices_listVoices_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"page":{"type":"integer"},"num_pages":{"type":"integer"},"page_size":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/VoicesGetResponsesContentApplicationJsonSchemaItemsItems"}}},"title":"Voices_listVoices_Response_200"},"VoicesPostResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"VoicesPostResponsesContentApplicationJsonSchemaItem"},"Voices_createVoice_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/VoicesPostResponsesContentApplicationJsonSchemaItem"}},"title":"Voices_createVoice_Response_200"},"VoicesVoiceUuidGetResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"VoicesVoiceUuidGetResponsesContentApplicationJsonSchemaItem"},"Voices_getVoice_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/VoicesVoiceUuidGetResponsesContentApplicationJsonSchemaItem"}},"title":"Voices_getVoice_Response_200"},"Voices_deleteVoice_Response_200":{"type":"object","properties":{"success":{"type":"boolean"}},"title":"Voices_deleteVoice_Response_200"},"Voices_buildVoice_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"title":"Voices_buildVoice_Response_200"},"VoicesVoiceUuidRecordingsGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{},"title":"VoicesVoiceUuidRecordingsGetResponsesContentApplicationJsonSchemaItemsItems"},"Recordings_listRecordings_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/VoicesVoiceUuidRecordingsGetResponsesContentApplicationJsonSchemaItemsItems"}}},"title":"Recordings_listRecordings_Response_200"},"VoicesVoiceUuidRecordingsPostResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"VoicesVoiceUuidRecordingsPostResponsesContentApplicationJsonSchemaItem"},"Recordings_createRecording_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/VoicesVoiceUuidRecordingsPostResponsesContentApplicationJsonSchemaItem"}},"title":"Recordings_createRecording_Response_200"},"VoicesVoiceUuidRecordingsRecordingIdGetResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"VoicesVoiceUuidRecordingsRecordingIdGetResponsesContentApplicationJsonSchemaItem"},"Recordings_getRecording_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/VoicesVoiceUuidRecordingsRecordingIdGetResponsesContentApplicationJsonSchemaItem"}},"title":"Recordings_getRecording_Response_200"},"Recordings_deleteRecording_Response_200":{"type":"object","properties":{"success":{"type":"boolean"}},"title":"Recordings_deleteRecording_Response_200"},"VoicesVoiceUuidRecordingsRecordingIdPatchResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"VoicesVoiceUuidRecordingsRecordingIdPatchResponsesContentApplicationJsonSchemaItem"},"Recordings_updateRecording_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/VoicesVoiceUuidRecordingsRecordingIdPatchResponsesContentApplicationJsonSchemaItem"}},"title":"Recordings_updateRecording_Response_200"},"TermSubstitutionsGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{},"title":"TermSubstitutionsGetResponsesContentApplicationJsonSchemaItemsItems"},"Term_Substitutions_listTermSubstitutions_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/TermSubstitutionsGetResponsesContentApplicationJsonSchemaItemsItems"}}},"title":"Term Substitutions_listTermSubstitutions_Response_200"},"TermSubstitutionsPostResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"TermSubstitutionsPostResponsesContentApplicationJsonSchemaItem"},"Term_Substitutions_createTermSubstitution_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/TermSubstitutionsPostResponsesContentApplicationJsonSchemaItem"}},"title":"Term Substitutions_createTermSubstitution_Response_200"},"TermSubstitutionsIdGetResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"TermSubstitutionsIdGetResponsesContentApplicationJsonSchemaItem"},"Term_Substitutions_getTermSubstitution_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/TermSubstitutionsIdGetResponsesContentApplicationJsonSchemaItem"}},"title":"Term Substitutions_getTermSubstitution_Response_200"},"Term_Substitutions_deleteTermSubstitution_Response_200":{"type":"object","properties":{"success":{"type":"boolean"}},"title":"Term Substitutions_deleteTermSubstitution_Response_200"},"PronunciationsGetParametersStatus":{"type":"string","enum":["pending","ready","failed"],"title":"PronunciationsGetParametersStatus"},"CustomPronunciationStatus":{"type":"string","enum":["pending","ready","failed"],"description":"Processing status. Only \"ready\" pronunciations are applied during synthesis.","title":"CustomPronunciationStatus"},"CustomPronunciation":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the pronunciation"},"word":{"type":"string","description":"The word or phrase this pronunciation applies to"},"status":{"$ref":"#/components/schemas/CustomPronunciationStatus","description":"Processing status. Only \"ready\" pronunciations are applied during synthesis."},"active":{"type":"boolean","description":"Whether this pronunciation is active and will be applied during synthesis"},"audio_url":{"type":"string","format":"uri","description":"URL to the uploaded reference audio"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"title":"CustomPronunciation"},"Custom_Pronunciations_listPronunciations_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomPronunciation"}}},"title":"Custom Pronunciations_listPronunciations_Response_200"},"Custom_Pronunciations_createPronunciation_Response_201":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/CustomPronunciation"}},"title":"Custom Pronunciations_createPronunciation_Response_201"},"PronunciationsBulkPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{},"title":"PronunciationsBulkPostResponsesContentApplicationJsonSchemaErrorsItems"},"Custom_Pronunciations_bulkCreatePronunciations_Response_201":{"type":"object","properties":{"success":{"type":"boolean"},"total_created":{"type":"integer","description":"Number of pronunciations successfully created"},"total_errors":{"type":"integer","description":"Number of files that failed validation"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomPronunciation"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/PronunciationsBulkPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"Custom Pronunciations_bulkCreatePronunciations_Response_201"},"Custom_Pronunciations_getPronunciation_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/CustomPronunciation"}},"title":"Custom Pronunciations_getPronunciation_Response_200"},"Custom_Pronunciations_deletePronunciation_Response_200":{"type":"object","properties":{"success":{"type":"boolean"}},"title":"Custom Pronunciations_deletePronunciation_Response_200"},"Custom_Pronunciations_updatePronunciation_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/CustomPronunciation"}},"title":"Custom Pronunciations_updatePronunciation_Response_200"},"VoiceSettingsPresetsGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{},"title":"VoiceSettingsPresetsGetResponsesContentApplicationJsonSchemaItemsItems"},"Voice_Settings_Presets_listVoiceSettingsPresets_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/VoiceSettingsPresetsGetResponsesContentApplicationJsonSchemaItemsItems"}}},"title":"Voice Settings Presets_listVoiceSettingsPresets_Response_200"},"VoiceSettingsPresetsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"VoiceSettingsPresetsPostResponsesContentApplicationJsonSchemaData"},"Voice_Settings_Presets_createVoiceSettingsPreset_Response_201":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/VoiceSettingsPresetsPostResponsesContentApplicationJsonSchemaData"},"message":{"type":"string"}},"title":"Voice Settings Presets_createVoiceSettingsPreset_Response_201"},"VoiceSettingsPresetsUuidGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"VoiceSettingsPresetsUuidGetResponsesContentApplicationJsonSchemaData"},"Voice_Settings_Presets_getVoiceSettingsPreset_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/VoiceSettingsPresetsUuidGetResponsesContentApplicationJsonSchemaData"}},"title":"Voice Settings Presets_getVoiceSettingsPreset_Response_200"},"Voice_Settings_Presets_deleteVoiceSettingsPreset_Response_200":{"type":"object","properties":{"success":{"type":"boolean"}},"title":"Voice Settings Presets_deleteVoiceSettingsPreset_Response_200"},"VoiceSettingsPresetsUuidPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"VoiceSettingsPresetsUuidPatchResponsesContentApplicationJsonSchemaData"},"Voice_Settings_Presets_updateVoiceSettingsPreset_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/VoiceSettingsPresetsUuidPatchResponsesContentApplicationJsonSchemaData"}},"title":"Voice Settings Presets_updateVoiceSettingsPreset_Response_200"},"ProjectsGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{},"title":"ProjectsGetResponsesContentApplicationJsonSchemaItemsItems"},"Projects_listProjects_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ProjectsGetResponsesContentApplicationJsonSchemaItemsItems"}}},"title":"Projects_listProjects_Response_200"},"ProjectsPostResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"ProjectsPostResponsesContentApplicationJsonSchemaItem"},"Projects_createProject_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/ProjectsPostResponsesContentApplicationJsonSchemaItem"}},"title":"Projects_createProject_Response_200"},"ProjectsProjectUuidGetResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"ProjectsProjectUuidGetResponsesContentApplicationJsonSchemaItem"},"Projects_getProject_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/ProjectsProjectUuidGetResponsesContentApplicationJsonSchemaItem"}},"title":"Projects_getProject_Response_200"},"ProjectsProjectUuidPutResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"ProjectsProjectUuidPutResponsesContentApplicationJsonSchemaItem"},"Projects_updateProject_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/ProjectsProjectUuidPutResponsesContentApplicationJsonSchemaItem"}},"title":"Projects_updateProject_Response_200"},"Projects_deleteProject_Response_200":{"type":"object","properties":{"success":{"type":"boolean"}},"title":"Projects_deleteProject_Response_200"},"ProjectsProjectUuidClipsGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{},"title":"ProjectsProjectUuidClipsGetResponsesContentApplicationJsonSchemaItemsItems"},"Clips_listClips_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ProjectsProjectUuidClipsGetResponsesContentApplicationJsonSchemaItemsItems"}}},"title":"Clips_listClips_Response_200"},"ProjectsProjectUuidClipsClipUuidGetResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"ProjectsProjectUuidClipsClipUuidGetResponsesContentApplicationJsonSchemaItem"},"Clips_getClip_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/ProjectsProjectUuidClipsClipUuidGetResponsesContentApplicationJsonSchemaItem"}},"title":"Clips_getClip_Response_200"},"Clips_deleteClip_Response_200":{"type":"object","properties":{"success":{"type":"boolean"}},"title":"Clips_deleteClip_Response_200"},"ProjectsProjectUuidClipsClipUuidPatchResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"ProjectsProjectUuidClipsClipUuidPatchResponsesContentApplicationJsonSchemaItem"},"Clips_updateClip_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/ProjectsProjectUuidClipsClipUuidPatchResponsesContentApplicationJsonSchemaItem"}},"title":"Clips_updateClip_Response_200"},"DuetVoicesGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{},"title":"DuetVoicesGetResponsesContentApplicationJsonSchemaItemsItems"},"Duets_listDuetVoices_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/DuetVoicesGetResponsesContentApplicationJsonSchemaItemsItems"}}},"title":"Duets_listDuetVoices_Response_200"},"DuetVoicesPostResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"DuetVoicesPostResponsesContentApplicationJsonSchemaItem"},"Duets_createDuetVoice_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/DuetVoicesPostResponsesContentApplicationJsonSchemaItem"}},"title":"Duets_createDuetVoice_Response_200"},"DuetVoicesIdPutResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"DuetVoicesIdPutResponsesContentApplicationJsonSchemaItem"},"Duets_updateDuetVoice_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/DuetVoicesIdPutResponsesContentApplicationJsonSchemaItem"}},"title":"Duets_updateDuetVoice_Response_200"},"Duets_deleteDuetVoice_Response_200":{"type":"object","properties":{"success":{"type":"boolean"}},"title":"Duets_deleteDuetVoice_Response_200"},"DuetVoicePairsGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{},"title":"DuetVoicePairsGetResponsesContentApplicationJsonSchemaItemsItems"},"Duets_listDuetVoicePairs_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/DuetVoicePairsGetResponsesContentApplicationJsonSchemaItemsItems"}}},"title":"Duets_listDuetVoicePairs_Response_200"},"DuetVoicePairsPostResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"DuetVoicePairsPostResponsesContentApplicationJsonSchemaItem"},"Duets_createDuetVoicePair_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/DuetVoicePairsPostResponsesContentApplicationJsonSchemaItem"}},"title":"Duets_createDuetVoicePair_Response_200"},"DuetPostRequestBodyContentApplicationJsonSchemaScriptItemsSpeaker":{"type":"string","enum":["0","1"],"description":"Speaker index (0 or 1)","title":"DuetPostRequestBodyContentApplicationJsonSchemaScriptItemsSpeaker"},"DuetPostRequestBodyContentApplicationJsonSchemaScriptItems":{"type":"object","properties":{"speaker":{"$ref":"#/components/schemas/DuetPostRequestBodyContentApplicationJsonSchemaScriptItemsSpeaker","description":"Speaker index (0 or 1)"},"text":{"type":"string","description":"Text for this speaker"}},"required":["speaker","text"],"title":"DuetPostRequestBodyContentApplicationJsonSchemaScriptItems"},"DuetPostResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{"uuid":{"type":"string"},"status":{"type":"string"}},"title":"DuetPostResponsesContentApplicationJsonSchemaItem"},"Duets_generateDuet_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/DuetPostResponsesContentApplicationJsonSchemaItem"}},"title":"Duets_generateDuet_Response_200"},"AccountGetResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{},"title":"AccountGetResponsesContentApplicationJsonSchemaItem"},"Account_getAccount_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/AccountGetResponsesContentApplicationJsonSchemaItem"}},"title":"Account_getAccount_Response_200"},"AccountTeamsGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{},"title":"AccountTeamsGetResponsesContentApplicationJsonSchemaItemsItems"},"Account_getTeams_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AccountTeamsGetResponsesContentApplicationJsonSchemaItemsItems"}}},"title":"Account_getTeams_Response_200"},"AccountTeamsTeamUuidGetResponsesContentApplicationJsonSchemaItem":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"plan":{"type":"string"},"voice_limit":{"type":"integer"},"units":{"type":"string"},"rate":{"type":"number","format":"double"},"current_usage":{"type":"integer"}},"title":"AccountTeamsTeamUuidGetResponsesContentApplicationJsonSchemaItem"},"Account_getTeam_Response_200":{"type":"object","properties":{"success":{"type":"boolean"},"item":{"$ref":"#/components/schemas/AccountTeamsTeamUuidGetResponsesContentApplicationJsonSchemaItem"}},"title":"Account_getTeam_Response_200"},"BillingPlanPlanType":{"type":"string","enum":["self_serve","custom","default"],"title":"BillingPlanPlanType"},"BillingPlanBillingInterval":{"type":"string","enum":["monthly","quarterly","annual"],"title":"BillingPlanBillingInterval"},"BillingPlanFamily":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"position":{"type":["integer","null"]}},"title":"BillingPlanFamily"},"BillingPlanProductCategory":{"type":"string","enum":["metered","subscription","base_fee","included_credits"],"title":"BillingPlanProductCategory"},"BillingProductRateTier":{"type":"object","properties":{"tier_order":{"type":"integer"},"min_quantity":{"type":"number","format":"double"},"max_quantity":{"type":["number","null"],"format":"double"},"rate_per_unit_cents":{"type":"integer"},"rate_per_unit_dollars":{"type":"number","format":"double"}},"title":"BillingProductRateTier"},"BillingProductFamily":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"position":{"type":["integer","null"]}},"title":"BillingProductFamily"},"BillingPlanProduct":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"slug":{"type":"string","description":"Stable product identifier used in product_quantities and changes requests."},"description":{"type":["string","null"]},"unit_type":{"type":"string"},"category":{"$ref":"#/components/schemas/BillingPlanProductCategory"},"rate_per_unit_cents":{"type":"integer"},"rate_per_unit_dollars":{"type":"number","format":"double"},"has_tiers":{"type":"boolean"},"tiers":{"type":"array","items":{"$ref":"#/components/schemas/BillingProductRateTier"}},"included_quantity":{"type":["number","null"],"format":"double"},"allow_additional_usage":{"type":"boolean","description":"Whether the plan permits the product quantity to be changed."},"min_usage_per_period":{"type":["number","null"],"format":"double","description":"Minimum allowed quantity for this product on the plan."},"max_usage_per_period":{"type":["number","null"],"format":"double","description":"Maximum allowed quantity for this product on the plan. Null means no plan-specific maximum."},"ui_visible":{"type":"boolean","description":"Whether the product is displayed in Resemble billing interfaces."},"product_family":{"oneOf":[{"$ref":"#/components/schemas/BillingProductFamily"},{"type":"null"}]}},"description":"A product and its pricing and quantity rules on a plan.","title":"BillingPlanProduct"},"BillingPlan":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"slug":{"type":"string","description":"Stable plan identifier used when creating or changing a subscription."},"plan_type":{"$ref":"#/components/schemas/BillingPlanPlanType"},"base_fee_cents":{"type":"integer"},"base_fee_dollars":{"type":"number","format":"double"},"total_base_cost_cents":{"type":"integer"},"total_base_cost_dollars":{"type":"number","format":"double"},"included_dollar_balance_cents":{"type":"integer"},"included_dollar_balance_dollars":{"type":"number","format":"double"},"billing_interval":{"$ref":"#/components/schemas/BillingPlanBillingInterval"},"plan_family":{"oneOf":[{"$ref":"#/components/schemas/BillingPlanFamily"},{"type":"null"}]},"active":{"type":"boolean"},"products":{"type":"array","items":{"$ref":"#/components/schemas/BillingPlanProduct"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"title":"BillingPlan"},"BillingPlansResponse":{"type":"object","properties":{"plans":{"type":"array","items":{"$ref":"#/components/schemas/BillingPlan"}}},"required":["plans"],"title":"BillingPlansResponse"},"BillingError":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}},"required":["error"],"title":"BillingError"},"BillingPlanResponse":{"type":"object","properties":{"plan":{"$ref":"#/components/schemas/BillingPlan"}},"required":["plan"],"title":"BillingPlanResponse"},"BillingSubscriptionStatus":{"type":"string","enum":["pending_payment","active_pending_payment","active","trialing","cancelled","expired","past_due","delinquent"],"title":"BillingSubscriptionStatus"},"BillingSubscriptionProductCategory":{"type":"string","enum":["metered","subscription","base_fee","included_credits"],"title":"BillingSubscriptionProductCategory"},"BillingSubscriptionProduct":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"slug":{"type":"string","description":"Product identifier to send as product_slug when updating quantities."},"unit_type":{"type":"string"},"category":{"$ref":"#/components/schemas/BillingSubscriptionProductCategory"},"description":{"type":["string","null"]},"active":{"type":"boolean"},"min_purchase_quantity":{"type":["number","null"],"format":"double"},"max_purchase_quantity":{"type":["number","null"],"format":"double"}},"title":"BillingSubscriptionProduct"},"BillingSubscriptionPlanProduct":{"type":"object","properties":{"included_quantity":{"type":["number","null"],"format":"double"},"allow_additional_usage":{"type":"boolean"},"min_usage_per_period":{"type":["number","null"],"format":"double"},"max_usage_per_period":{"type":["number","null"],"format":"double"}},"description":"Quantity rules inherited from the subscription's current plan.","title":"BillingSubscriptionPlanProduct"},"BillingSubscriptionItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"quantity":{"type":"number","format":"double","description":"Current absolute quantity on the subscription."},"consumed_quantity":{"type":"number","format":"double","description":"Quantity currently in use. A product cannot be reduced below this value."},"product":{"$ref":"#/components/schemas/BillingSubscriptionProduct"},"plan_product":{"oneOf":[{"$ref":"#/components/schemas/BillingSubscriptionPlanProduct"},{"type":"null"}]},"rate_per_unit_cents":{"type":"number","format":"double","description":"Locked-in unit rate for this subscription item."},"current_rate_per_unit_cents":{"type":"number","format":"double","description":"Current catalog unit rate for comparison."},"is_grandfathered":{"type":"boolean"},"rate_locked_at":{"type":["string","null"],"format":"date-time"},"ui_visible":{"type":"boolean"}},"title":"BillingSubscriptionItem"},"BillingSubscription":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"plan":{"$ref":"#/components/schemas/BillingPlan"},"status":{"$ref":"#/components/schemas/BillingSubscriptionStatus"},"current_period_start":{"type":"string","format":"date-time"},"current_period_end":{"type":"string","format":"date-time"},"cancel_at_period_end":{"type":"boolean"},"cancel_at":{"type":["string","null"],"format":"date-time"},"activated_at":{"type":["string","null"],"format":"date-time"},"invoice_due_date":{"type":["string","null"],"format":"date"},"delinquent_at":{"type":["string","null"],"format":"date-time"},"subscription_items":{"type":"array","items":{"$ref":"#/components/schemas/BillingSubscriptionItem"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"title":"BillingSubscription"},"BillingSubscriptionResponse":{"type":"object","properties":{"subscription":{"oneOf":[{"$ref":"#/components/schemas/BillingSubscription"},{"type":"null"}]}},"required":["subscription"],"title":"BillingSubscriptionResponse"},"BillingForbiddenError":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable authorization or eligibility error."},"error_code":{"type":["string","null"],"description":"Machine-readable error code when one is available."}},"required":["error"],"title":"BillingForbiddenError"},"BillingProductQuantityChange":{"type":"object","properties":{"product_slug":{"type":"string","description":"Product slug returned by the subscription response."},"new_quantity":{"type":"number","format":"double","minimum":0,"description":"Desired absolute total, not an increment or decrement."}},"required":["product_slug","new_quantity"],"title":"BillingProductQuantityChange"},"BillingUpdateProductsRequest":{"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#/components/schemas/BillingProductQuantityChange"}}},"required":["changes"],"title":"BillingUpdateProductsRequest"},"BillingPaymentActionRequired":{"type":"object","properties":{"requires_action":{"type":"boolean"},"client_secret":{"type":"string","description":"Client secret used to complete the required payment authentication."}},"required":["requires_action","client_secret"],"title":"BillingPaymentActionRequired"},"BillingValidationErrors":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}},"required":["errors"],"title":"BillingValidationErrors"},"UpdateBillingSubscriptionProductsRequestUnprocessableEntityError":{"oneOf":[{"$ref":"#/components/schemas/BillingError"},{"$ref":"#/components/schemas/BillingValidationErrors"}],"title":"UpdateBillingSubscriptionProductsRequestUnprocessableEntityError"},"BillingConfirmPaymentRequest":{"type":"object","properties":{"payment_intent_id":{"type":"string","description":"Payment intent identifier completed by the customer."}},"required":["payment_intent_id"],"title":"BillingConfirmPaymentRequest"},"ConfirmBillingSubscriptionPaymentRequestUnprocessableEntityError":{"oneOf":[{"$ref":"#/components/schemas/BillingError"},{"$ref":"#/components/schemas/BillingValidationErrors"}],"title":"ConfirmBillingSubscriptionPaymentRequestUnprocessableEntityError"},"BillingChangePlanRequest":{"type":"object","properties":{"plan_slug":{"type":"string"},"product_quantities":{"type":"object","additionalProperties":{"type":"number","format":"double","minimum":0},"description":"Optional map of product slugs to desired quantities on the new plan."}},"required":["plan_slug"],"title":"BillingChangePlanRequest"},"ChangeBillingPlanRequestUnprocessableEntityError":{"oneOf":[{"$ref":"#/components/schemas/BillingError"},{"$ref":"#/components/schemas/BillingValidationErrors"}],"title":"ChangeBillingPlanRequestUnprocessableEntityError"},"BillingWallet":{"type":"object","properties":{"balance_cents":{"type":"number","format":"double"},"balance_dollars":{"type":"number","format":"double"},"cash_balance_cents":{"type":"number","format":"double"},"cash_balance_dollars":{"type":"number","format":"double"},"promotional_balance_cents":{"type":"number","format":"double"},"promotional_balance_dollars":{"type":"number","format":"double"},"lifetime_loaded_cents":{"type":"number","format":"double"},"lifetime_loaded_dollars":{"type":"number","format":"double"},"lifetime_consumed_cents":{"type":"number","format":"double"},"lifetime_consumed_dollars":{"type":"number","format":"double"},"low_balance":{"type":"boolean"}},"title":"BillingWallet"},"BillingWalletResponse":{"type":"object","properties":{"wallet":{"$ref":"#/components/schemas/BillingWallet"}},"title":"BillingWalletResponse"},"BillingWalletTransactionTransactionType":{"type":"string","enum":["credit_purchase","trial_credit","promotion_bonus","usage_deduction","refund","manual_adjustment","subscription_renewal_credit","promotional_credit_adjustment","plan_change","plan_subscription","subscription_cancellation"],"title":"BillingWalletTransactionTransactionType"},"BillingWalletTransaction":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"transaction_type":{"$ref":"#/components/schemas/BillingWalletTransactionTransactionType"},"amount_cents":{"type":"number","format":"double","description":"Positive for credits and negative for debits."},"balance_after_cents":{"type":"number","format":"double"},"description":{"type":["string","null"]},"metadata":{"type":"object","additionalProperties":{"description":"Any type"}},"created_at":{"type":"string","format":"date-time"}},"title":"BillingWalletTransaction"},"BillingPagination":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"title":"BillingPagination"},"BillingTransactionsResponse":{"type":"object","properties":{"transactions":{"type":"array","items":{"$ref":"#/components/schemas/BillingWalletTransaction"}},"pagination":{"$ref":"#/components/schemas/BillingPagination"}},"required":["transactions"],"title":"BillingTransactionsResponse"},"BillingAutoReloadSetting":{"type":"object","properties":{"enabled":{"type":"boolean"},"reload_amount_cents":{"type":"integer"},"reload_amount_dollars":{"type":"number","format":"double"},"minimum_balance_threshold_cents":{"type":"integer"},"minimum_balance_threshold_dollars":{"type":"number","format":"double"},"maximum_monthly_spend_cents":{"type":"integer"},"maximum_monthly_spend_dollars":{"type":"number","format":"double"},"current_month_spend_cents":{"type":"integer"},"current_month_spend_dollars":{"type":"number","format":"double"},"remaining_monthly_allowance_cents":{"type":"integer"},"remaining_monthly_allowance_dollars":{"type":"number","format":"double"},"has_payment_method":{"type":"boolean"},"can_reload":{"type":"boolean"}},"title":"BillingAutoReloadSetting"},"BillingAutoReloadResponse":{"type":"object","properties":{"auto_reload":{"oneOf":[{"$ref":"#/components/schemas/BillingAutoReloadSetting"},{"type":"null"}]},"minimum_reload_amount_cents":{"type":"integer"},"maximum_reload_amount_cents":{"type":"integer"}},"title":"BillingAutoReloadResponse"},"BillingUpdateAutoReloadRequest":{"type":"object","properties":{"enabled":{"type":"boolean"},"reload_amount_cents":{"type":"integer","minimum":0},"minimum_balance_threshold_cents":{"type":"integer","minimum":0},"maximum_monthly_spend_cents":{"type":"integer","minimum":0}},"required":["enabled","reload_amount_cents","minimum_balance_threshold_cents","maximum_monthly_spend_cents"],"title":"BillingUpdateAutoReloadRequest"},"Billing_Wallet_updateBillingAutoReload_Response_200":{"type":"object","properties":{"auto_reload":{"$ref":"#/components/schemas/BillingAutoReloadSetting"}},"title":"Billing Wallet_updateBillingAutoReload_Response_200"},"UpdateBillingAutoReloadRequestUnprocessableEntityError":{"oneOf":[{"$ref":"#/components/schemas/BillingError"},{"$ref":"#/components/schemas/BillingValidationErrors"}],"title":"UpdateBillingAutoReloadRequestUnprocessableEntityError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"API key from https://app.resemble.ai/hub/api"}}}}