Skip to main content
POST
/
v1
/
discovery_tasks
Create Discovery Task
curl --request POST \
  --url https://api.extruct.ai/v1/discovery_tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>",
  "desired_num_results": 100,
  "notify": true,
  "table": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "run": false,
    "columns": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "auto_import": false
  },
  "auto_data_sources": true,
  "data_sources": [
    "web_search"
  ],
  "criteria": [
    {
      "key": "<string>",
      "name": "<string>",
      "criterion": "<string>"
    }
  ]
}'
{
  "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>"
    }
  ]
}
Creates a new company discovery task. All company lists are collected in real-time, mostly using Public Web. You can request up to 1000 results. Our infrastructure scales depending on a load, but you can expect ~100 companies per minute added to the result set. Query Examples:
  • sustainable clothing manufacturers in Guangzhou
  • innovation consulting agencies
  • ai startups building llm search
  • emerging streetwear fashion brands in Italy with unique identity
  • help me to find companies that could be useful for a potential partnership for an early HFT fund

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
query
string
required

Ideal description of companies to find

​
desired_num_results
integer
default:100
Required range: 1 <= x <= 10000
​
notify
boolean
default:true
​
table
object | null
​
auto_data_sources
boolean
default:true

Automatically determine best data sources based on query

​
data_sources
enum<string>[] | null

Manual data source selection (ignored if auto_data_sources=True)

​
criteria
CriterionDefinition · object[] | null

Optional criteria for evaluating discovered companies. Each criterion will be graded on a 1-5 scale.

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
​
criteria
CriterionDefinition · object[] | null