Dashboard
API
- Overview
- Get started
- How It Works
- Core
- Websets
- Items
- Searches
- Enrichments
- Webhooks
- Events
List all Items for a Webset
Returns a list of Webset Items.
You can paginate through the Items using the cursor
parameter.
curl --request GET \
--url https://api.exa.ai/websets/v0/websets/{webset}/items \
--header 'x-api-key: <api-key>'
{
"data": [
{
"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"
}
],
"hasMore": true,
"nextCursor": "<string>"
}
Authorizations
Your Exa API key
Path Parameters
The id or externalId of the Webset
Query Parameters
The cursor to paginate through the results
1
The number of results to return
1 <= x <= 200
Response
The list of webset items
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
Whether there are more Items to paginate through
The cursor to paginate through the next set of Items
curl --request GET \
--url https://api.exa.ai/websets/v0/websets/{webset}/items \
--header 'x-api-key: <api-key>'
{
"data": [
{
"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"
}
],
"hasMore": true,
"nextCursor": "<string>"
}