How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Airweave collections API

The collections API from Airweave — 2 operation(s) for collections.

Airweave collections API is one of 5 APIs that Airweave publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 5 operations across 2 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.airweave.ai, http://localhost:8001.

5 operations 2 paths 17 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.airweave.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Airweave collections API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (default).

Paths & Operations 5

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

collections 5
GET
/collections
List Collections
list-collections-get 4 params → 200422429
POST
/collections
Create Collection
create-collections-post 1 param body → 200422429
GET
/collections/{readable_id}
Get Collection
get-collections-readable-id-get 2 params → 200404422429
PATCH
/collections/{readable_id}
Update Collection
update-collections-readable-id-patch 2 params body → 200404422429
DELETE
/collections/{readable_id}
Delete Collection
delete-collections-readable-id-delete 2 params → 200404422429

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Collection (13 properties), SyncConfig (4 properties), ValidationErrorDetail (3 properties), ValidationError (3 properties). Each schema is shown below with its type and property counts.

ValidationErrorDetail
object
Details about a validation error for a specific field.
3 properties 3 required
HTTPValidationError
object
1 property
ValidationErrorLocItems
CollectionCreate
object
Schema for creating a new collection. Collections serve as logical containers for organizing related data sources. Once created, you can add source connections…
3 properties 1 required
NotFoundErrorResponse
object
Response returned when a resource is not found (HTTP 404).
1 property 1 required
DestinationConfig
object
Controls where entities are written.
3 properties
HandlerConfig
object
Controls which handlers run during sync.
3 properties
CollectionStatus
string
Collection status enum.
SourceConnectionSummary
object
Lightweight summary of a source connection for collection list display.
2 properties 2 required
RateLimitErrorResponse
object
Response returned when rate limit is exceeded (HTTP 429). The API enforces rate limits to ensure fair usage. When exceeded, wait for the duration specified in…
1 property 1 required
SyncConfig
object
Sync configuration with automatic env var loading. Env vars use double underscore as delimiter: SYNCCONFIGHANDLERSENABLEVECTORHANDLERS=false
4 properties
ValidationErrorResponse
object
Response returned when request validation fails (HTTP 422). This occurs when the request body contains invalid data, such as malformed URLs, invalid event type…
1 property 1 required
ValidationError
object
3 properties 3 required
CursorConfig
object
Controls incremental sync cursor behavior.
2 properties
Collection
object
API-facing collection schema with embedding metadata. Extends CollectionRecord with vectorsize and embeddingmodelname, which are resolved by the CollectionServ…
13 properties 8 required
CollectionUpdate
object
Schema for updating an existing collection. Allows updating the collection's display name and default sync configuration. The readableid is immutable to mainta…
2 properties
BehaviorConfig
object
Miscellaneous execution behavior flags.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

airweave-collections-api-openapi.yml Raw ↑

Other APIs Airweave publishes across the network.

Airweave collections > search API
Airweave source-connections API
Airweave sources API
Airweave webhooks API
Where this information came from

This is an independent, third-party profile of Airweave collections API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.