Integrations

Create an integration

Changed on

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, and config are required.
  • name must be unique within the account. LLM names are unique among LLM integrations; AGENT and EVALUATOR names share the same remote endpoint integration namespace.
  • Server-set fields (id, created_at, updated_at) are not accepted on input.
  • scopings defaults to account-wide visibility when omitted.
  • For type: EVALUATOR, config.endpoint and config.input_schema are required. config.headers is optional (omit means no headers; pass null or {} on PATCH to clear them). config.headers is encrypted at rest and never returned — reads surface has_headers instead.
  • type: EVALUATOR requires the remote evaluators feature to be enabled for the account. If not enabled the request returns 403.
  • config.provider TYPE_SAFE_AI, PERPLEXITY, and CLOUDFLARE create integrations that are used only by Decision Judge evaluators. They take api_key only (plus account_id for CLOUDFLARE); any other config field returns 422. Creating one returns 400 when 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 as 403.

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"
}

<Warning>This endpoint is in alpha, read more here.</Warning>

post/v2/integrations

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/integrations
  • Auth
    HTTP bearer

Request body

OR
OR

Response

An integration object.

OR
OR

Changes

    • breaking

      added to the //// response property oneOf list for the response status

    • info

      added TYPE_SAFE_AI PERPLEXITY CLOUDFLARE discriminator mapping keys to the //// request property

    • info

      added to the //// request property oneOf list

    • info

      added TYPE_SAFE_AI PERPLEXITY CLOUDFLARE discriminator mapping keys to the //// response property for the response status

    • breaking

      added to the //// response property oneOf list for the response status

    • info

      added the new optional request property /////////

    • info

      added TOGETHER_AI discriminator mapping keys to the //// request property

    • info

      added to the //// request property oneOf list

    • info

      added TOGETHER_AI discriminator mapping keys to the //// response property for the response status

    • info

      added the required property ///////// to the response with the status