Skip to main content
POST
/
v1
/
discovery_tasks
/
{task_id}
/
resume
Resume Discovery Task
curl --request POST \
  --url https://api.extruct.ai/v1/discovery_tasks/{task_id}/resume \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "desired_new_results": 25
}
'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "status": "created",
  "query": "<string>",
  "desired_num_results": 123,
  "is_exhausted": false,
  "num_results_discovered": 0,
  "num_results_enriched": 0,
  "num_results_evaluated": 0,
  "num_results": 0,
  "table_id": "<string>",
  "auto_data_sources": true,
  "data_sources": [
    "web_search"
  ],
  "criteria": [
    {
      "key": "<string>",
      "name": "<string>",
      "criterion": "<string>"
    }
  ]
}

​
Overview

This endpoint requests additional results for an existing Deep Search task. If the task is already exhausted, the request fails with 400 Bad Request.

​
Example request

export EXTRUCT_API_TOKEN="YOUR_API_TOKEN"
export TASK_ID="YOUR_TASK_ID"

curl -X POST "https://api.extruct.ai/v1/discovery_tasks/${TASK_ID}/resume" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${EXTRUCT_API_TOKEN}" \
  -d '{"desired_new_results": 25}'

​
Key parameters

  • task_id (required): Task identifier.
  • desired_new_results (optional): additional result count; default 25, min 0, max 250.
Resume requests are still constrained by the task-level 250-result cap. If is_exhausted=true, this request returns 400 Bad Request. That means the task has no more additional candidates to return.

​
Success signal

A successful response returns updated task state. Track progress via task status and results endpoints.

​
Common errors

​
401 Unauthorized

Check that your header is Authorization: Bearer ${EXTRUCT_API_TOKEN}.

​
404 Not Found

The task ID is invalid or unavailable in your workspace.

​
422 Unprocessable Entity

Most often caused by invalid JSON or desired_new_results outside 0..250.

​
400 Bad Request

Returned when the task is already exhausted and cannot be resumed for more results.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
task_id
string
required

Body

application/json
​
desired_new_results
integer
default:25

Additional results requested for an existing task. Limited by the 250-result task cap.

Required range: 0 <= x <= 250

Response

Successful Response

​
id
string
required
​
created_at
string<date-time>
required
​
status
enum<string>
required
Available options:
created,
in_progress,
done,
failed
​
query
string
required
​
desired_num_results
integer
required
​
is_exhausted
boolean
default:false
​
num_results_discovered
integer
default:0

Total number of company candidates discovered from search

​
num_results_enriched
integer
default:0

Number of candidates enriched with company profiles

​
num_results_evaluated
integer
default:0

Number of candidates that had criteria evaluation completed

​
num_results
integer
default:0

Total number of results

​
table_id
string | null
​
auto_data_sources
boolean
default:true
​
data_sources
enum<string>[] | null
Available options:
web_search,
linkedin,
maps
​
criteria
CriterionDefinition · object[] | null