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

The Searches API from Exa — 3 operation(s) for searches.

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

This API exposes 3 operations across 3 paths, and defines 11 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.

3 operations 3 paths 11 schemas 1 GET2 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 Searches 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 3

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

Searches 3
POST
/v0/websets/{webset}/searches
Create a Search
websets-searches-create 1 param body → 200
GET
/v0/websets/{webset}/searches/{id}
Get a Search
websets-searches-get 2 params → 200
POST
/v0/websets/{webset}/searches/{id}/cancel
Cancel a running Search
websets-searches-cancel 2 params → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are WebsetSearch (19 properties), CreateWebsetSearchParameters (10 properties), CustomEntity (2 properties), CreateCriterionParameters (1 property). Each schema is shown below with its type and property counts.

Entity
CustomEntity
object
2 properties 2 required
WebsetSearchCanceledReason
string
PersonEntity
object
1 property 1 required
ArticleEntity
object
1 property 1 required
CompanyEntity
object
1 property 1 required
WebsetSearch
object
19 properties 17 required
CreateWebsetSearchParameters
object
10 properties 2 required
CreateCriterionParameters
object
1 property 1 required
WebsetSearchBehavior
string
ResearchPaperEntity
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

exa-ai-searches-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