Submit Detection Job
POST https://app.resemble.ai/api/v2/detect
By default the request is asynchronous. The API responds immediately with a job UUID while analysis continues in the background. Include Prefer: wait to block until completion.
Required Field
Optional Parameters
Response
Asynchronous Response
By default, the API responds immediately while processing continues in the background:
Use the UUID to check status via the Get Detection Result endpoint, or provide a callback_url to receive results automatically.
Synchronous Response (with Prefer: wait header)
When using the Prefer: wait header, the API returns complete results immediately:
Audio File Response
Image File Response
Video File Response
Privacy Mode
When privacy_mode=true, the API enables a privacy lifecycle for the submitted media:
- URL redaction:
urlandaudio_urlare set tonullin all responses, both during processing and after completion. - Filename tokenization: The original filename is replaced with a tokenized value (e.g.,
redacted_abc123def4567890abcd1234.mp3). - Media deletion: After detection completes (including any downstream tasks like intelligence or source tracing), the uploaded file is permanently deleted from storage. The
file_deleted_attimestamp is set once the purge succeeds. - Downstream records: Related records (intelligence, source tracing, identity) are still created but do not store copies of the media.
Privacy mode is request-driven only — team-level or UI defaults are not applied to API requests. You must explicitly pass privacy_mode: true on each request.
Privacy Mode Request Example
Privacy Mode Response Example
Once the media file has been purged, media_deleted becomes true and file_deleted_at is populated:
Callback URL
If you provide a callback_url when submitting a media file, you will receive a POST request to that URL with the same payload structure as the synchronous response shown above. When intelligence analysis was requested, the callback payload will include the intelligence field with the analysis results.
