Get Discovery Task Results

GET

discovery_tasks

{task_id}

results

curl --request GET \
  --url https://api.extruct.ai/v1/discovery_tasks/{task_id}/results \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.extruct.ai/v1/discovery_tasks/{task_id}/results"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.extruct.ai/v1/discovery_tasks/{task_id}/results', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extruct.ai/v1/discovery_tasks/{task_id}/results",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extruct.ai/v1/discovery_tasks/{task_id}/results"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extruct.ai/v1/discovery_tasks/{task_id}/results")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "query": "<string>",
  "desired_num_results": 123,
  "results": [
    {
      "id": "<string>",
      "task_id": "<string>",
      "company_name": "<string>",
      "company_description": "<string>",
      "company_website": "<string>",
      "relevance": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "company_profile_id": "<string>",
      "source": "web_search",
      "scores": {},
      "founding_year": 123,
      "hq_country": "<string>",
      "hq_state_province": "<string>",
      "hq_city": "<string>",
      "company_full_description": "<string>"
    }
  ],
  "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": [],
  "criteria": [
    {
      "key": "<string>",
      "name": "<string>",
      "criterion": "<string>"
    }
  ],
  "exclude_domains": [
    "<string>"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Overview

This endpoint returns paginated Deep Search results for a task. Results can be read while the task is running or after it completes.

Example request

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

curl --get "https://api.extruct.ai/v1/discovery_tasks/${TASK_ID}/results" \
  -H "Authorization: Bearer ${EXTRUCT_API_TOKEN}" \
  --data-urlencode "offset=0" \
  --data-urlencode "limit=50"

Key parameters

task_id (required): Task identifier.
offset (optional): Pagination offset.
limit (optional): Page size.

Results are ordered by relevance descending.

Endpoint behavior

relevance controls the overall ordering of the result list.
scores shows the grade and explanation for each criterion. If you did not provide criteria when creating the task, Deep Search generates them automatically.
Use this endpoint to review companies. Use Get Task for progress and completion state.

Success signal

A successful response includes results[] with criterion scores details. Continue paging until returned rows are fewer than limit. Use task completion rules from task status endpoint: status=done or is_exhausted=true.

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. Re-check TASK_ID from create-task response.

Get Task Endpoint

Deep Search

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

Query Parameters

offset

integer | null

limit

integer | null

Response

Successful Response

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

results

DiscoveryTaskResultOutput · object[]

required

Show child attributes

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

Show child attributes

exclude_domains

string[] | null

The resolved, sorted list of registered domains that were excluded from this run.

Get Discovery Task Results

curl --request GET \
  --url https://api.extruct.ai/v1/discovery_tasks/{task_id}/results \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.extruct.ai/v1/discovery_tasks/{task_id}/results"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.extruct.ai/v1/discovery_tasks/{task_id}/results', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extruct.ai/v1/discovery_tasks/{task_id}/results",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extruct.ai/v1/discovery_tasks/{task_id}/results"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extruct.ai/v1/discovery_tasks/{task_id}/results")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "query": "<string>",
  "desired_num_results": 123,
  "results": [
    {
      "id": "<string>",
      "task_id": "<string>",
      "company_name": "<string>",
      "company_description": "<string>",
      "company_website": "<string>",
      "relevance": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "company_profile_id": "<string>",
      "source": "web_search",
      "scores": {},
      "founding_year": 123,
      "hq_country": "<string>",
      "hq_state_province": "<string>",
      "hq_city": "<string>",
      "company_full_description": "<string>"
    }
  ],
  "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": [],
  "criteria": [
    {
      "key": "<string>",
      "name": "<string>",
      "criterion": "<string>"
    }
  ],
  "exclude_domains": [
    "<string>"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

API Reference

Company Search

Deep Search

Deep Research

Table Management

Table Execution

Other

Get Discovery Task Results

Overview

Example request

Key parameters

Endpoint behavior

Success signal

Common errors

`401 Unauthorized`

`404 Not Found`

Authorizations

Path Parameters

Query Parameters

Response

​Overview

​Example request

​Key parameters

​Endpoint behavior

​Success signal

​Common errors

​401 Unauthorized

​404 Not Found

​Related endpoints

​Related guides

Authorizations

Path Parameters

Query Parameters

Response

Overview

Example request

Key parameters

Endpoint behavior

Success signal

Common errors

`401 Unauthorized`

`404 Not Found`

Related endpoints

Related guides