Create an integration
Create a new integration. The type field selects the config shape;
for LLM, config.provider selects the per-provider config.
Supported types: LLM, AGENT, EVALUATOR.
Payload Requirements
type,name, andconfigare required.namemust be unique within the account.LLMnames are unique among LLM integrations;AGENTandEVALUATORnames share the same remote endpoint integration namespace.- Server-set fields (
id,created_at,updated_at) are not accepted on input. scopingsdefaults to account-wide visibility when omitted.- For
type: EVALUATOR,config.endpointandconfig.input_schemaare required.config.headersis optional (omit means no headers; passnullor{}on PATCH to clear them).config.headersis encrypted at rest and never returned — reads surfacehas_headersinstead. type: EVALUATORrequires the remote evaluators feature to be enabled for the account. If not enabled the request returns403.
Valid example (type: EVALUATOR)
{
"type": "EVALUATOR",
"name": "My remote evaluator",
"config": {
"endpoint": "https://eval.example.com/evaluate",
"input_schema": { "type": "object" }
}
}
Invalid example (missing required config.endpoint)
{
"type": "EVALUATOR",
"name": "My remote evaluator",
"config": {
"input_schema": { "type": "object" }
}
}
Invalid example (missing required config)
{
"type": "EVALUATOR",
"name": "My remote evaluator"
}
Authorizations
Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format
Body
Create a new integration. The type field selects the config shape; for
LLM, config.provider selects the per-provider config.
Payload Requirements
type,name, andconfigare required.namemust be unique within the account.LLMnames are unique among LLM integrations;AGENTandEVALUATORnames share the same remote endpoint integration namespace.scopingsdefaults to account-wide visibility when omitted.- Type- and provider-specific rules (required fields, defaults, write-only
secrets) are documented on each config schema: see the per-provider
members of
CreateLlmConfigfortype: LLM,CreateAgentConfigfortype: AGENT, andCreateEvaluatorIntegrationConfigInputfortype: EVALUATOR.
Valid example
{ "type": "LLM", "name": "Production OpenAI", "config": { "provider": "OPEN_AI", "api_key": "sk-abc123..." } }
Invalid example (missing required config)
{ "type": "LLM", "name": "Bad Integration" }
Invalid example (missing required config.provider for type: LLM)
{ "type": "LLM", "name": "Bad Integration", "config": {} }
- Option 1
- Option 2
- Option 3
Discriminator identifying this request as an LLM integration.
LLM Integration name. Unique per (account, type).
Provider-specific configuration for the LLM integration, selected by config.provider.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
Show child attributes
Show child attributes
Visibility scoping rules. Defaults to account-wide.
Show child attributes
Show child attributes
Response
An integration object.
- Option 1
- Option 2
- Option 3
A polymorphic integration resource. The type field selects the config shape; for LLM, config.provider selects the per-provider config.
The unique identifier for the integration.
Discriminator identifying an LLM integration.
LLM The integration name. Unique per (account, type).
Visibility scoping rules. Account-wide when empty.
Show child attributes
Show child attributes
When the integration was created.
When the integration was last updated.
Unique identifier of the user who created the integration.
Per-provider LLM config, discriminated by provider.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
Show child attributes
Show child attributes
Was this page helpful?