AimableDocs
DocsAPI Reference
POST/v1/spaces/{space_id}/collections/{collection_id}/connectors

Create Collection Connector

Path Parameters

NameTypeRequiredDescription
space_idstring (uuid)Required
collection_idstring (uuid)Required

Headers

NameTypeRequiredDescription
Idempotency-KeystringRequired
X-API-KeystringOptional

Request Body

application/jsonRequired
provider_slugstringRequired
credentialobjectRequiredCredential payload — shape depends on provider auth_type
scope_configobject

Request

curl -X POST '/api-proxy/v1/spaces/{space_id}/collections/{collection_id}/connectors' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "provider_slug": "string",
  "credential": {},
  "scope_config": {}
}'

Response

201(generated)
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "collection_id": "550e8400-e29b-41d4-a716-446655440000",
    "provider_slug": "string",
    "principal_id": "550e8400-e29b-41d4-a716-446655440000",
    "scope_config": {},
    "status": "string",
    "sync_schedule": {},
    "last_synced_at": {},
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}

Error Responses