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.config.providerTYPE_SAFE_AI,PERPLEXITY, andCLOUDFLAREcreate integrations that are used only by Decision Judge evaluators. They takeapi_keyonly (plusaccount_idforCLOUDFLARE); any other config field returns422. Creating one returns400when this deployment has not enabled the provider. That is a deployment setting, separate from the account’s Decision Judge access that the evaluator and task endpoints report as403.
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
Service accounts may instead present an access token issued by an external identity provider (Microsoft Entra ID) when the account admin has configured that provider. Send it in the same header: Authorization: Bearer <access-token>.
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
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.
Was this page helpful?