EXexa
Websets

Create a Webset

Changed on

Creates a new Webset with optional search, import, and enrichment configurations. The Webset will automatically begin processing once created.

You can specify an externalId to reference the Webset with your own identifiers for easier integration.

post/v0/websets

Request

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

Request body

titlestring nullable

Optional name that appears anywhere the Webset is displayed. Leave empty to have Exa generate one automatically.

externalIdstring

The external identifier for the webset.

You can use this to reference the Webset by your own internal identifiers.

metadataobject

Set of key-value pairs you want to associate with this object.

Example request

{
  "search": {
    "query": "Marketing agencies based in the US, that focus on consumer products.",
    "count": 10
  }
}

Response

Webset created

idstring required

The unique identifier for the webset

object'webset' required

The type of object

status'idle' | 'pending' | 'running' | 'paused' required

The status of the webset

externalIdstring nullable required

The external identifier for the webset

titlestring nullable required

The title of the webset

metadataobject

Set of key-value pairs you want to associate with this object.

dashboardUrlstring uri required

The URL to view the webset in the Exa dashboard

createdAtstring date-time required

The date and time the webset was created

updatedAtstring date-time required

The date and time the webset was updated

Changes

  • a56858d08d37Revision changes
    • warning

      the /// request property's maxLength was set to 250

    • warning

      the / request property's maxLength was set to 250

  • 068993f25c35Revision changes
    • breaking

      added 'propertyNames' constraint to the request property //

    • breaking

      added 'propertyNames' constraint to the request property

    • info

      added 'propertyNames' constraint to the // response property for the status

    • info

      added 'propertyNames' constraint to the // response property for the status

    • info

      added 'propertyNames' constraint to the response property for the status

    • info

      added 'propertyNames' constraint to the // response property for the status

    • info

      added 'propertyNames' constraint to the // response property for the status