Sign in

v1

latestOpenAPI 3.1.02026-07-26231646860.9 KB
integrations

Create or update custom integration

put/v2/integrations/custom

Request body

authentication_type'api_key' | 'none' | 'oauth2'

Authentication types for custom integrations.

Values:

  • none: No authentication required
  • oauth2: OAuth2 token-based authentication
  • api_key: API key header-based authentication
modelsstring[] nullable

List of model names for the custom integration. Deprecated: use model_properties instead.

is_legacy_formatboolean

Internal: whether this config was created from the legacy 'models' field.

default_modelstring nullable

Default model to use. If not provided, defaults to the first model.

endpointstring required

Endpoint URL for the custom integration.

authentication_scopestring nullable

Optional scope for OAuth2 authentication.

oauth2_token_urlstring nullable

OAuth2 token URL for custom OAuth2 authentication. If not provided, defaults to the endpoint.

api_key_headerstring nullable

HTTP header name to use for API key authentication (e.g., 'X-API-Key', 'Authorization').

api_key_valuestring nullable

API key value to send in the specified header for authentication.

custom_header_mappingobject nullable

Custom header mapping from internal fields (job_id, user_id, project_id, run_id) to custom header names to be included in LLM requests.

headersobject nullable

Optional custom HTTP headers to include in requests to the integration endpoint. Stored encrypted at rest.

tokenstring nullable

Response

Successful Response

idstring uuid4 required
namestring required
provider'anthropic' | 'aws_bedrock' | 'aws_sagemaker' | 'azure' | 'custom' | 'databricks' | 'mistral' | 'nvidia' | 'openai' | 'vegas_gateway' | 'vertex_ai' | 'writer' required
created_atstring date-time required
updated_atstring date-time required
created_bystring uuid4 required
is_selectedboolean
is_disabledboolean