Detect Email Address API

What it does

Submits a job to detect email addresses from the provided content and returns identifiers you can use to check the job later. The endpoint starts processing asynchronously and does not return the detected emails directly.

Request Body

Response

Returns a JSON object with a job_id string field and a status_url string field. Use job_id to identify the submitted asynchronous job, and status_url to check its status.
Success response: 200

Notes

This endpoint kicks off an async job and returns immediately with a job identifier; the actual work runs in the background. Pair this call with the corresponding job_check endpoint — poll that until the status reaches a terminal state to retrieve the result. Extract the job identifier from job_id.

What it does

Retrieves the current status of a Detect Emails background job identified by its job ID. The response returns a JSON object with a data object that includes the job identifier, job type, and an attributes object containing the job status and result list.

Path Parameter(s)

Response

Returns a JSON object with a data object. Inside data, id and type are strings, and attributes is an object containing type (string), result (string array), and status (string).