Create a new connection with validation.
This endpoint validates the provided credentials and configuration against the integration’s requirements before creating the connection.
Validation includes:
Example:
{
"label": "My Gmail Connection",
"integration": "gmail",
"integration_type": "connectors",
"auth_method_id": "oauth2",
"credentials": {
"access_token": "ya29.a0...",
"refresh_token": "1//0g...",
"token_type": "Bearer",
"expires_at": "2025-10-19T12:00:00Z"
},
"config": {}
}
Error Response (validation failure):
{
"detail": {
"message": "Connection validation failed",
"errors": [
"Field 'API Key' is required",
"Field 'Email' must be a valid email address"
]
}
}
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The workspace ID
Schema for creating a new connection.
Integration name (slack, github, etc.)
Type of integration (connectors, mcp, tool, model, storage, api, custom)
connectors, mcp, tool, model, custom, storage, api Human-readable label for the connection
255Integration-specific configuration
ID of the credential to use for this connection
User ID who owns this connection
Credentials to use for this connection
Authentication method ID to use (defaults to integration's default method)
Successful Response
Schema for reading connection data.
Integration name (slack, github, etc.)
Type of integration (connectors, mcp, tool, model, storage, api, custom)
connectors, mcp, tool, model, custom, storage, api active, inactive, testing, error, expired Human-readable label for the connection
255Integration-specific configuration