Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Exa Websets API

The Websets API from Exa — 3 operation(s) for websets.

Exa Websets API is one of 19 APIs that Exa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Websets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 6 operations across 3 paths, and defines 29 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.exa.ai.

6 operations 3 paths 29 schemas 1 DELETE2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.exa.ai
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Exa Websets API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (apiKey). It accepts HTTP bearer tokens (bearer). By default, every request must be authenticated.

  • apiKey — Pass your Exa API key in the x-api-key header. You can also authenticate with Authorization: Bearer .
  • bearer — Pass your Exa API key in the x-api-key header. You can also authenticate with Authorization: Bearer .

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Websets 6
POST
/v0/websets
Create a Webset
websets-create body → 201409
GET
/v0/websets
List all Websets
websets-list 3 params → 200
GET
/v0/websets/{id}
Get a Webset
websets-get 2 params → 200404
POST
/v0/websets/{id}
Update a Webset
websets-update 1 param body → 200404
DELETE
/v0/websets/{id}
Delete a Webset
websets-delete 1 param → 200404
POST
/v0/websets/{id}/cancel
Cancel a running Webset
websets-cancel 1 param → 200

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are WebsetSearch (19 properties), Webset (14 properties), Import (13 properties), WebsetEnrichment (12 properties). Each schema is shown below with its type and property counts.

WebsetEnrichmentFormat
string
WebsetItemArticleProperties
object
5 properties 5 required
CustomEntity
object
2 properties 2 required
WebsetSearchCanceledReason
string
Monitor
object
11 properties 11 required
PersonEntity
object
1 property 1 required
WebsetSearch
object
19 properties 17 required
WebsetItemCustomProperties
object
5 properties 5 required
Import
object
13 properties 13 required
CreateEnrichmentParameters
object
4 properties 1 required
Entity
ArticleEntity
object
1 property 1 required
CompanyEntity
object
1 property 1 required
WebsetItemEvaluation
object
4 properties 3 required
MonitorRun
object
11 properties 11 required
WebsetItemResearchPaperProperties
object
5 properties 5 required
ResearchPaperEntity
object
1 property 1 required
UpdateWebsetRequest
object
2 properties
WebsetEnrichment
object
12 properties 11 required
Webset
object
14 properties 12 required
WebsetItemPersonProperties
object
4 properties 4 required
ListWebsetsResponse
object
3 properties 3 required
WebsetItemCompanyProperties
object
5 properties 5 required
CreateWebsetParameters
object
7 properties
GetWebsetResponse
WebsetItem
object
11 properties 10 required
EnrichmentResult
object
7 properties 7 required
CreateCriterionParameters
object
1 property 1 required
WebsetSearchBehavior
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

exa-ai-websets-api-openapi.yml Raw ↑

Other APIs Exa publishes across the network.

Exa Agent API
Exa Answer API
Exa Contents API
Exa Enrichments API
Exa Events API
Exa Imports API
Exa Items API
Exa Monitors API
Exa Monitors Runs API
Exa Research API
Exa Runs API
Exa Search API