Dashboard
API
- Overview
- Get started
- How It Works
- Core
- Websets
- Items
- Searches
- Enrichments
- Webhooks
- Events
Get a Webset
curl --request GET \
--url https://api.exa.ai/websets/v0/websets/{id} \
--header 'x-api-key: <api-key>'{
"id": "<string>",
"object": "webset",
"status": "idle",
"externalId": "<string>",
"searches": [
{
"id": "<string>",
"object": "webset_search",
"status": "created",
"query": "<string>",
"entity": {
"type": "company"
},
"criteria": [
{
"description": "<string>",
"successRate": 50
}
],
"count": 2,
"progress": {
"found": 123,
"completion": 50
},
"metadata": {},
"canceledAt": "2023-11-07T05:31:56Z",
"canceledReason": "webset_deleted",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"enrichments": [
{
"id": "<string>",
"object": "webset_enrichment",
"status": "pending",
"websetId": "<string>",
"title": "<string>",
"description": "<string>",
"format": "text",
"options": [
{
"label": "<string>"
}
],
"instructions": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"items": [
{
"id": "<string>",
"object": "webset_item",
"source": "search",
"sourceId": "<string>",
"websetId": "<string>",
"properties": {
"type": "person",
"url": "<string>",
"description": "<string>",
"person": {
"name": "<string>",
"location": "<string>",
"position": "<string>",
"pictureUrl": "<string>"
}
},
"evaluations": [
{
"criterion": "<string>",
"reasoning": "<string>",
"satisfied": "yes",
"references": []
}
],
"enrichments": [
{
"object": "enrichment_result",
"format": "text",
"result": [
"<string>"
],
"reasoning": "<string>",
"references": [
{
"title": "<string>",
"snippet": "<string>",
"url": "<string>"
}
],
"enrichmentId": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}Authorizations
Your Exa API key
Path Parameters
The id or externalId of the Webset.
Query Parameters
Expand the response with the specified resources
items Response
The unique identifier for the webset
"webset"The status of the webset
idle, running, paused The external identifier for the webset
The searches that have been performed on the webset.
The unique identifier for the search
"webset_search"The status of the search
created, running, completed, canceled The query used to create the search.
1 - 5000The entity the search will return results for.
When no entity is provided during creation, we will automatically select the best entity based on the query.
"company"The criteria the search will use to evaluate the results. If not provided, we will automatically generate them for you.
The number of results the search will attempt to find. The actual number of results may be less than this number depending on the search complexity.
x >= 1The date and time the search was canceled
The reason the search was canceled
webset_deleted, webset_canceled The date and time the search was created
The date and time the search was updated
The Enrichments to apply to the Webset Items.
The unique identifier for the enrichment
"webset_enrichment"The status of the enrichment
pending, canceled, completed The unique identifier for the Webset this enrichment belongs to.
The title of the enrichment.
This will be automatically generated based on the description and format.
The description of the enrichment task provided during the creation of the enrichment.
The format of the enrichment response.
text, date, number, options, email, phone When the format is options, the different options for the enrichment agent to choose from.
The label of the option
The instructions for the enrichment Agent.
This will be automatically generated based on the description and format.
The date and time the enrichment was created
The date and time the enrichment was updated
The date and time the webset was created
The date and time the webset was updated
Set of key-value pairs you want to associate with this object.
1000When expand query parameter contains items, this will contain the items in the webset
The unique identifier for the Webset Item
"webset_item"The source of the Item
search The unique identifier for the source
The unique identifier for the Webset this Item belongs to.
The properties of the Item
"person"The URL of the person profile
Short description of the relevance of the person
The name of the person
The location of the person
The current work position of the person
The image URL of the person
The criteria evaluations of the item
The description of the criterion
The reasoning for the result of the evaluation
The satisfaction of the criterion
yes, no, unclear The enrichments results of the Webset item
"enrichment_result"text, date, number, options, email, phone The result of the enrichment.
The reasoning for the result when an Agent is used.
The id of the Enrichment that generated the result
The date and time the item was created
The date and time the item was last updated
curl --request GET \
--url https://api.exa.ai/websets/v0/websets/{id} \
--header 'x-api-key: <api-key>'{
"id": "<string>",
"object": "webset",
"status": "idle",
"externalId": "<string>",
"searches": [
{
"id": "<string>",
"object": "webset_search",
"status": "created",
"query": "<string>",
"entity": {
"type": "company"
},
"criteria": [
{
"description": "<string>",
"successRate": 50
}
],
"count": 2,
"progress": {
"found": 123,
"completion": 50
},
"metadata": {},
"canceledAt": "2023-11-07T05:31:56Z",
"canceledReason": "webset_deleted",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"enrichments": [
{
"id": "<string>",
"object": "webset_enrichment",
"status": "pending",
"websetId": "<string>",
"title": "<string>",
"description": "<string>",
"format": "text",
"options": [
{
"label": "<string>"
}
],
"instructions": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"items": [
{
"id": "<string>",
"object": "webset_item",
"source": "search",
"sourceId": "<string>",
"websetId": "<string>",
"properties": {
"type": "person",
"url": "<string>",
"description": "<string>",
"person": {
"name": "<string>",
"location": "<string>",
"position": "<string>",
"pictureUrl": "<string>"
}
},
"evaluations": [
{
"criterion": "<string>",
"reasoning": "<string>",
"satisfied": "yes",
"references": []
}
],
"enrichments": [
{
"object": "enrichment_result",
"format": "text",
"result": [
"<string>"
],
"reasoning": "<string>",
"references": [
{
"title": "<string>",
"snippet": "<string>",
"url": "<string>"
}
],
"enrichmentId": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}