EXexa
Websets

Get a Webset

Changed on

Returns a Webset by id or externalId, including its status, searches, imports, enrichments, and monitors.

Pass expand=items to include up to the first 100 items in the response.

get/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.

Query parameters

expandstring[]

Expand the response with the specified resources

Response

Webset

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

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

  • 982a352e3781Revision changes
    • info

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

    • info

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

    • info

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