EXexa
Websets

Update a Webset

Changed on

Updates the title or metadata of a Webset. Searches, imports, and enrichments are managed through their own endpoints.

post/v0/websets/{id}

Request

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

Path parameters

idstring required

The id or externalId of the Webset

Request body

metadataobject nullable

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

titlestring

Optional name that appears anywhere the Webset is displayed.

Example request

{
  "title": "Leading climate tech startups"
}

Response

Webset updated

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

  • 068993f25c35Revision changes
    • 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