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 source-connections API

The source-connections API from Airweave — 5 operation(s) for source-connections.

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

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

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

8 operations 5 paths 30 schemas 1 DELETE3 GET1 PATCH3 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 source-connections API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (default).

Paths & Operations 8

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

source-connections 8
GET
/source-connections
List Source Connections
list-source-connections-get 4 params → 200422429
POST
/source-connections
Create Source Connection
create-source-connections-post 1 param body → 200422429
GET
/source-connections/{source_connection_id}
Get Source Connection
get-source-connections-source-connection-id-get 2 params → 200404422429
PATCH
/source-connections/{source_connection_id}
Update Source Connection
update-source-connections-source-connection-id-patch 2 params body → 200404422429
DELETE
/source-connections/{source_connection_id}
Delete Source Connection
delete-source-connections-source-connection-id-delete 2 params → 200404422429
GET
/source-connections/{source_connection_id}/jobs
List Sync Jobs
get-source-connection-jobs-source-connections-source-connection-id-jobs-get 3 params → 200404422429
POST
/source-connections/{source_connection_id}/run
Run Sync
run-source-connections-source-connection-id-run-post 3 params → 200404409422429
POST
/source-connections/{source_connection_id}/jobs/{job_id}/cancel
Cancel Sync Job
cancel-job-source-connections-source-connection-id-jobs-job-id-cancel-post 3 params → 200404409422429

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are SourceConnection (20 properties), SourceConnectionJob (13 properties), SourceConnectionListItem (11 properties), SyncJobDetails (11 properties). Each schema is shown below with its type and property counts.

EntitySummary
object
Entity state summary.
7 properties
SourceConnectionJob
object
A sync job representing a single synchronization run. Sync jobs track the execution of data synchronization from a source connection. Each job includes timing…
13 properties 3 required
OAuthTokenAuthentication
object
OAuth authentication with pre-obtained token.
3 properties 1 required
AuthenticationDetails
object
Authentication information.
10 properties 2 required
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
SourceConnectionErrorCategory
string
Error categories for credential/auth failures on source connections.
SyncDetails
object
Sync execution details.
4 properties
HTTPValidationError
object
1 property
ValidationErrorLocItems
SyncJobDetails
object
Sync job details.
11 properties 2 required
ConflictErrorResponse
object
Response returned when a resource conflict occurs (HTTP 409). This typically occurs when attempting to create a resource that already exists, or when an operat…
1 property 1 required
SourceConnection
object
Complete source connection details including auth, config, sync status, and entities. This schema provides full information about a source connection, suitable…
20 properties 9 required
ScheduleDetails
object
Schedule information.
4 properties
EntityTypeStats
object
Statistics for a specific entity type.
2 properties 1 required
ValidationError
object
3 properties 3 required
SourceConnectionUpdateAuthentication
Updated authentication credentials (direct auth only)
NotFoundErrorResponse
object
Response returned when a resource is not found (HTTP 404).
1 property 1 required
AuthProviderAuthentication
object
Authentication via external provider.
2 properties 1 required
ValidationErrorDetail
object
Details about a validation error for a specific field.
3 properties 3 required
SourceConnectionCreate
object
Create a source connection with authentication configuration. Source connections link a data source (e.g., GitHub, Slack) to a collection. The authentication m…
9 properties 2 required
SourceConnectionUpdate
object
Update an existing source connection's configuration. All fields are optional. Only include fields you want to change; omitted fields retain their current valu…
5 properties
ScheduleConfig
object
Schedule configuration for syncs.
3 properties
SourceConnectionStatus
string
Source connection status enum - represents overall connection state.
SourceConnectionListItem
object
Lightweight source connection representation for list views. Contains essential fields for display and navigation. For full details including sync history and…
11 properties 9 required
OAuthBrowserAuthentication
object
OAuth authentication via browser flow. Supports both OAuth2 and OAuth1 BYOC (Bring Your Own Client): - OAuth2 BYOC: Provide clientid + clientsecret - OAuth1 BY…
5 properties
SourceConnectionCreateAuthentication
Authentication configuration. Type is auto-detected from provided fields.
DirectAuthentication
object
Direct authentication with API keys or passwords.
1 property 1 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
SyncJobStatus
string
Sync job status enum.
AuthenticationMethod
string
Authentication methods for source connections.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

airweave-source-connections-api-openapi.yml Raw ↑

Other APIs Airweave publishes across the network.

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

This is an independent, third-party profile of Airweave source-connections 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.