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

The Enrichments API from Exa — 3 operation(s) for enrichments.

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

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

5 operations 3 paths 4 schemas 1 DELETE1 GET1 PATCH2 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 Enrichments 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 5

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

Enrichments 5
POST
/v0/websets/{webset}/enrichments
Create an Enrichment
websets-enrichments-create 1 param body → 200
PATCH
/v0/websets/{webset}/enrichments/{id}
Update an Enrichment
websets-enrichments-update 2 params body → 200
GET
/v0/websets/{webset}/enrichments/{id}
Get an Enrichment
websets-enrichments-get 2 params → 200
DELETE
/v0/websets/{webset}/enrichments/{id}
Delete an Enrichment
websets-enrichments-delete 2 params → 200
POST
/v0/websets/{webset}/enrichments/{id}/cancel
Cancel a running Enrichment
websets-enrichments-cancel 2 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are WebsetEnrichment (12 properties), UpdateEnrichmentParameters (4 properties), CreateEnrichmentParameters (4 properties). Each schema is shown below with its type and property counts.

WebsetEnrichment
object
12 properties 11 required
CreateEnrichmentParameters
object
4 properties 1 required
WebsetEnrichmentFormat
string
UpdateEnrichmentParameters
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Exa publishes across the network.

Exa Agent API
Exa Answer API
Exa Contents 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
Exa Searches API