Create Source Connection

Create a new source connection.

This endpoint creates:

An integration credential with the provided auth fields
A collection if not provided
The source connection
A sync configuration and DAG
A sync job if immediate execution is requested

Args: db: The database session source_connection_in: The source connection to create auth_context: The current authentication context background_tasks: Background tasks for async operations

Returns: The created source connection

Request

This endpoint expects an object.

namestringRequired>=4 characters<=42 characters

Name of the source connection

short_namestringRequired

descriptionstringOptional

config_fieldsmap from strings to anyOptional

Config values model. Implements "flat dictionary" semantics, where no values are dictionaries.

white_label_idstringOptionalformat: "uuid"

collectionstringOptional

cron_schedulestringOptional

auth_fieldsmap from strings to anyOptional

Config values model. Implements "flat dictionary" semantics, where no values are dictionaries.

credential_idstringOptionalformat: "uuid"

sync_immediatelybooleanOptionalDefaults to true

Response

Successful Response

namestring>=4 characters<=42 characters

Name of the source connection

short_namestring

idstringformat: "uuid"

organization_idstringformat: "uuid"

created_atdatetime

modified_atdatetime

collectionstring

descriptionstring or null

config_fieldsmap from strings to any or null

Config values model. Implements "flat dictionary" semantics, where no values are dictionaries.

white_label_idstring or nullformat: "uuid"

sync_idstring or nullformat: "uuid"

connection_idstring or nullformat: "uuid"

created_by_emailstring or nullformat: "email"

modified_by_emailstring or nullformat: "email"

auth_fieldsmap from strings to any or string or null

statusenum or null

Source connection status enum.

Allowed values:

latest_sync_job_statusenum or null

Sync job status enum.

latest_sync_job_idstring or nullformat: "uuid"

latest_sync_job_started_atdatetime or null

latest_sync_job_completed_atdatetime or null

latest_sync_job_errorstring or null

cron_schedulestring or null

next_scheduled_rundatetime or null

1	curl -X POST https://api.airweave.ai/source-connections \
2	-H "Content-Type: application/json" \
3	-d '{
4	"name": "My Stripe Connection",
5	"short_name": "stripe",
6	"description": "Production Stripe account for payment data",
7	"collection": "finance-data",
8	"cron_schedule": "0 /6 * *",
9	"auth_fields": {
10	"api_key": "sk_live_51H..."
11	},
12	"sync_immediately": true
13	}'

1	{
2	"name": "My Stripe Connection",
3	"short_name": "stripe",
4	"id": "550e8400-e29b-41d4-a716-446655440000",
5	"organization_id": "org12345-6789-abcd-ef01-234567890abc",
6	"created_at": "2024-01-15T09:30:00Z",
7	"modified_at": "2024-01-15T14:22:15Z",
8	"collection": "finance-data",
9	"description": "Production Stripe account for payment data",
10	"config_fields": {
11	"key": "value"
12	},
13	"white_label_id": "white_label_id",
14	"sync_id": "123e4567-e89b-12d3-a456-426614174000",
15	"connection_id": "conn9876-5432-10fe-dcba-098765432100",
16	"created_by_email": "finance@company.com",
17	"modified_by_email": "finance@company.com",
18	"auth_fields": {
19	"api_key": "sk_live_51H..."
20	},
21	"status": "active",
22	"latest_sync_job_status": "completed",
23	"latest_sync_job_id": "987fcdeb-51a2-43d7-8f3e-1234567890ab",
24	"latest_sync_job_started_at": "2024-01-15T14:00:00Z",
25	"latest_sync_job_completed_at": "2024-01-15T14:05:22Z",
26	"latest_sync_job_error": "latest_sync_job_error",
27	"cron_schedule": "0 /6 * *",
28	"next_scheduled_run": "2024-01-16T02:00:00Z"
29	}

Create Source Connection

Headers

Request

Response

Errors