What are async APIs?
Asynchronous API endpoints let you start jobs that may take some time to complete, such as research or crawling tasks. Instead of waiting for an immediate response, you receive a job ID and can check the status or retrieve results once the job is finished.How to run
1
Create job
Make a request to async API endpoint (e.g. deep version of Similar companies API:
POST /companies/similar/deep
). In a response you will receive a job ID.2
Check status
Make a
GET /jobs/{jobId}
request to check job status. Until the job is completed, the response will include status: "pending"
or status: "processing"
.3
Retrieve results
When the job is completed (
status: "completed"
), you will receive results in the response to your request for check status (GET /jobs/{jobId}
). Job results are available for 24 hours.