EXexa
Websets Preview

Preview a webset

Changed on

Returns how a search query will be interpreted before you create a Webset, including the detected entity, generated criteria, and suggested enrichments.

post/v0/websets/preview

Request

  • Base URL
    https://api.exa.ai/websets
  • URL
    https://api.exa.ai/websets/v0/websets/preview
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

searchboolean

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

Request body

Example request

{
  "search": {
    "query": "Marketing agencies based in the US, that focus on consumer products. Get brands worked with and city"
  }
}

Response

Preview of the webset

Changes

  • 9aab9665f650Revision changes
    • warning

      deleted the path request parameter search

    • info

      added the new optional query request parameter search

  • 982a352e3781Revision changes
    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status