List all Items for a Webset

cURL

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>",
          "company": {
            "name": "<string>",
            "location": "<string>"
          },
          "pictureUrl": "<string>"
        }
      },
      "evaluations": [
        {
          "criterion": "<string>",
          "reasoning": "<string>",
          "satisfied": "yes",
          "references": []
        }
      ],
      "enrichments": [
        {
          "object": "enrichment_result",
          "status": "pending",
          "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>"
}

GET

websets

{webset}

items

cURL

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>",
          "company": {
            "name": "<string>",
            "location": "<string>"
          },
          "pictureUrl": "<string>"
        }
      },
      "evaluations": [
        {
          "criterion": "<string>",
          "reasoning": "<string>",
          "satisfied": "yes",
          "references": []
        }
      ],
      "enrichments": [
        {
          "object": "enrichment_result",
          "status": "pending",
          "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

x-api-key

string

header

required

Your Exa API key

Path Parameters

webset

string

required

The id or externalId of the Webset

Query Parameters

cursor

string

The cursor to paginate through the results

Minimum string length: 1

limit

number

default:20

The number of results to return

Required range: 1 <= x <= 100

sourceId

string

The id of the source

Response

200 - application/json

Webset Items

data

object[]

required

The list of webset items

Show child attributes

data.id

string

required

The unique identifier for the Webset Item

data.object

string

default:webset_item

required

Allowed value: "webset_item"

data.source

enum<string>

required

The source of the Item

Available options:

search,

import

data.sourceId

string

required

The unique identifier for the source

data.websetId

string

required

The unique identifier for the Webset this Item belongs to.

data.properties

Person · object

required

The properties of the Item

Person
Company
Article
Research Paper
Custom

Show child attributes

data.properties.type

string

default:person

required

Allowed value: "person"

data.properties.url

string<uri>

required

The URL of the person profile

data.properties.description

string

required

Short description of the relevance of the person

data.properties.person

WebsetItemPersonPropertiesFields · object

required

Show child attributes

data.properties.person.name

string

required

The name of the person

data.properties.person.location

string | null

required

The location of the person

data.properties.person.position

string | null

required

The current work position of the person

data.properties.person.company

WebsetItemPersonCompanyPropertiesFields · object

required

Show child attributes

data.properties.person.company.name

string

required

The name of the company

data.properties.person.company.location

string | null

required

The location the person is working at the company

data.properties.person.pictureUrl

string<uri> | null

required

The image URL of the person

data.evaluations

object[]

required

The criteria evaluations of the item

Show child attributes

data.evaluations.criterion

string

required

The description of the criterion

data.evaluations.reasoning

string

required

The reasoning for the result of the evaluation

data.evaluations.satisfied

enum<string>

required

The satisfaction of the criterion

Available options:

yes,

no,

unclear

data.evaluations.references

object[]

The references used to generate the result.

Show child attributes

data.evaluations.references.title

string | null

required

The title of the reference

data.evaluations.references.snippet

string | null

required

The relevant snippet of the reference content

data.evaluations.references.url

string<uri>

required

The URL of the reference

data.enrichments

object[] | null

required

The enrichments results of the Webset item

Show child attributes

data.enrichments.object

string

default:enrichment_result

required

Allowed value: "enrichment_result"

data.enrichments.status

enum<string>

required

The status of the enrichment result.

Available options:

pending,

completed,

canceled

data.enrichments.format

enum<string>

required

Available options:

text,

date,

number,

options,

email,

phone,

url

data.enrichments.result

string[] | null

required

The result of the enrichment.

data.enrichments.reasoning

string | null

required

The reasoning for the result when an Agent is used.

data.enrichments.references

object[]

required

The references used to generate the result.

Show child attributes

data.enrichments.references.title

string | null

required

The title of the reference

data.enrichments.references.snippet

string | null

required

The relevant snippet of the reference content

data.enrichments.references.url

string<uri>

required

The URL of the reference

data.enrichments.enrichmentId

string

required

The id of the Enrichment that generated the result

data.createdAt

string<date-time>

required

The date and time the item was created

data.updatedAt

string<date-time>

required

The date and time the item was last updated

hasMore

boolean

required

Whether there are more Items to paginate through

nextCursor

string | null

required

The cursor to paginate through the next set of Items

Delete an Item Create a Search

⌘I

Getting Started

Dashboard

API

List all Items for a Webset

Authorizations

Path Parameters

Query Parameters

Response