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 Preview API

The Websets Preview API from Exa — 1 operation(s) for websets preview.

Exa Websets Preview 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 Preview. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 14 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.

1 operations 1 paths 14 schemas 1 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 Preview 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Websets Preview 1
POST
/v0/websets/preview
Preview a webset
websets-preview 1 param body → 200422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are WebsetItemArticleProperties (5 properties), WebsetItemCompanyProperties (5 properties), WebsetItemResearchPaperProperties (5 properties), WebsetItemCustomProperties (5 properties). Each schema is shown below with its type and property counts.

WebsetItemPreview
object
3 properties 3 required
WebsetItemCompanyProperties
object
5 properties 5 required
Entity
CustomEntity
object
2 properties 2 required
WebsetItemArticleProperties
object
5 properties 5 required
PreviewWebsetParameters
object
1 property 1 required
PersonEntity
object
1 property 1 required
ArticleEntity
object
1 property 1 required
CompanyEntity
object
1 property 1 required
PreviewWebsetResponse
object
3 properties 3 required
WebsetItemCustomProperties
object
5 properties 5 required
WebsetItemPersonProperties
object
4 properties 4 required
WebsetItemResearchPaperProperties
object
5 properties 5 required
ResearchPaperEntity
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

exa-ai-websets-preview-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