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

Estuary Collections API

The Collections API from Estuary — 3 operation(s) for collections.

Estuary Collections API is one of 8 APIs that Estuary publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Collections. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.estuary.dev.

3 operations 3 paths 2 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.estuary.dev
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Estuary Collections API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Access token obtained from /rpc/generateaccesstoken by exchanging a refresh token. Sent as Authorization: Bearer .

Paths & Operations 3

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

Collections 3
GET
/live_specs
List live catalog specifications.
listLiveSpecs 3 params → 200
GET
/live_specs/{id}
Get a single live specification.
getLiveSpec 1 param → 200
GET
/live_spec_flows
List data-flow edges between live specs (source to target lineage).
listLiveSpecFlows → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are LiveSpec (10 properties), LiveSpecFlow (3 properties). Each schema is shown below with its type and property counts.

LiveSpecFlow
object
3 properties
LiveSpec
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

estuary-collections-api-openapi.yml Raw ↑

Other APIs Estuary publishes across the network.

Estuary Auth API
Estuary Captures API
Estuary Connectors API
Estuary Drafts API
Estuary Materializations API
Estuary Publications API
Estuary Tenants API