Skip to main content
POST
/
v0
/
websets
/
preview
cURL
curl --request POST \
  --url https://api.exa.ai/websets/v0/websets/preview \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "search": {
    "query": "<string>",
    "entity": {
      "type": "company"
    },
    "count": 10
  }
}
'
{
  "search": {
    "entity": {
      "type": "company"
    },
    "criteria": [
      {
        "description": "<string>"
      }
    ]
  },
  "enrichments": [
    {
      "description": "<string>",
      "format": "text",
      "options": [
        {
          "label": "<string>"
        }
      ]
    }
  ],
  "items": [
    {
      "id": "<string>",
      "properties": {
        "type": "person",
        "url": "<string>",
        "description": "<string>",
        "person": {
          "name": "<string>",
          "location": "<string>",
          "position": "<string>",
          "company": {
            "name": "<string>",
            "location": "<string>"
          },
          "pictureUrl": "<string>"
        }
      },
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Your Exa API key

Path Parameters

Weather you want to search for a preview list of items or not

Body

application/json

Search parameters

Response

Preview of the webset

enrichments
object[]
required

Detected enrichments from the query.

items
object[]
required

Preview items matching the search criteria.