Update an integration

curl --request PATCH \
  --url https://api.arize.com/v2/integrations/{integration_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "LLM",
  "name": "<string>",
  "scopings": [
    {
      "organization_id": "<string>",
      "space_id": "<string>"
    }
  ],
  "config": {
    "api_key": "<string>",
    "is_function_calling_enabled": true,
    "auth": {
      "auth_type": "DEFAULT",
      "role_arn": "<string>",
      "external_id": "<string>",
      "base_url": "<string>"
    },
    "base_url": "<string>",
    "headers": {},
    "is_default_models_enabled": true,
    "model_names": [
      "<string>"
    ],
    "project_id": "<string>",
    "location": "<string>",
    "project_access_label": "<string>"
  }
}
'

import requests

url = "https://api.arize.com/v2/integrations/{integration_id}"

payload = {
    "type": "LLM",
    "name": "<string>",
    "scopings": [
        {
            "organization_id": "<string>",
            "space_id": "<string>"
        }
    ],
    "config": {
        "api_key": "<string>",
        "is_function_calling_enabled": True,
        "auth": {
            "auth_type": "DEFAULT",
            "role_arn": "<string>",
            "external_id": "<string>",
            "base_url": "<string>"
        },
        "base_url": "<string>",
        "headers": {},
        "is_default_models_enabled": True,
        "model_names": ["<string>"],
        "project_id": "<string>",
        "location": "<string>",
        "project_access_label": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'LLM',
    name: '<string>',
    scopings: [{organization_id: '<string>', space_id: '<string>'}],
    config: {
      api_key: '<string>',
      is_function_calling_enabled: true,
      auth: {
        auth_type: 'DEFAULT',
        role_arn: '<string>',
        external_id: '<string>',
        base_url: '<string>'
      },
      base_url: '<string>',
      headers: {},
      is_default_models_enabled: true,
      model_names: ['<string>'],
      project_id: '<string>',
      location: '<string>',
      project_access_label: '<string>'
    }
  })
};

fetch('https://api.arize.com/v2/integrations/{integration_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arize.com/v2/integrations/{integration_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'LLM',
    'name' => '<string>',
    'scopings' => [
        [
                'organization_id' => '<string>',
                'space_id' => '<string>'
        ]
    ],
    'config' => [
        'api_key' => '<string>',
        'is_function_calling_enabled' => true,
        'auth' => [
                'auth_type' => 'DEFAULT',
                'role_arn' => '<string>',
                'external_id' => '<string>',
                'base_url' => '<string>'
        ],
        'base_url' => '<string>',
        'headers' => [
                
        ],
        'is_default_models_enabled' => true,
        'model_names' => [
                '<string>'
        ],
        'project_id' => '<string>',
        'location' => '<string>',
        'project_access_label' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arize.com/v2/integrations/{integration_id}"

	payload := strings.NewReader("{\n  \"type\": \"LLM\",\n  \"name\": \"<string>\",\n  \"scopings\": [\n    {\n      \"organization_id\": \"<string>\",\n      \"space_id\": \"<string>\"\n    }\n  ],\n  \"config\": {\n    \"api_key\": \"<string>\",\n    \"is_function_calling_enabled\": true,\n    \"auth\": {\n      \"auth_type\": \"DEFAULT\",\n      \"role_arn\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"base_url\": \"<string>\"\n    },\n    \"base_url\": \"<string>\",\n    \"headers\": {},\n    \"is_default_models_enabled\": true,\n    \"model_names\": [\n      \"<string>\"\n    ],\n    \"project_id\": \"<string>\",\n    \"location\": \"<string>\",\n    \"project_access_label\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.arize.com/v2/integrations/{integration_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"LLM\",\n  \"name\": \"<string>\",\n  \"scopings\": [\n    {\n      \"organization_id\": \"<string>\",\n      \"space_id\": \"<string>\"\n    }\n  ],\n  \"config\": {\n    \"api_key\": \"<string>\",\n    \"is_function_calling_enabled\": true,\n    \"auth\": {\n      \"auth_type\": \"DEFAULT\",\n      \"role_arn\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"base_url\": \"<string>\"\n    },\n    \"base_url\": \"<string>\",\n    \"headers\": {},\n    \"is_default_models_enabled\": true,\n    \"model_names\": [\n      \"<string>\"\n    ],\n    \"project_id\": \"<string>\",\n    \"location\": \"<string>\",\n    \"project_access_label\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arize.com/v2/integrations/{integration_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"LLM\",\n  \"name\": \"<string>\",\n  \"scopings\": [\n    {\n      \"organization_id\": \"<string>\",\n      \"space_id\": \"<string>\"\n    }\n  ],\n  \"config\": {\n    \"api_key\": \"<string>\",\n    \"is_function_calling_enabled\": true,\n    \"auth\": {\n      \"auth_type\": \"DEFAULT\",\n      \"role_arn\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"base_url\": \"<string>\"\n    },\n    \"base_url\": \"<string>\",\n    \"headers\": {},\n    \"is_default_models_enabled\": true,\n    \"model_names\": [\n      \"<string>\"\n    ],\n    \"project_id\": \"<string>\",\n    \"location\": \"<string>\",\n    \"project_access_label\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "TGxtSW50ZWdyYXRpb246MTI6YUJjRA==",
  "type": "LLM",
  "name": "Production OpenAI",
  "scopings": [
    {
      "organization_id": null,
      "space_id": null
    }
  ],
  "created_at": "2026-02-13T21:27:19.055Z",
  "updated_at": "2026-02-13T21:27:19.279Z",
  "created_by_user_id": "VXNlcjoxOm5OYkM=",
  "config": {
    "provider": "OPEN_AI",
    "has_api_key": true,
    "is_function_calling_enabled": true
  }
}

{
  "status": 400,
  "title": "Invalid request parameters",
  "detail": "The 'name' field is required and must be a non-empty string.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#invalid-request"
}

{
  "status": 401,
  "title": "Authentication required",
  "detail": "You must be authenticated to access this resource.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#authentication-required"
}

{
  "status": 403,
  "title": "Access forbidden",
  "detail": "You do not have permission to access this resource.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#access-forbidden"
}

{
  "status": 404,
  "title": "Resource not found",
  "detail": "The requested resource with ID '12345' was not found.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-not-found"
}

{
  "status": 409,
  "title": "Resource conflict",
  "detail": "A resource with the given identifier already exists.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-conflict"
}

{
  "status": 422,
  "title": "Unprocessable Entity",
  "detail": "One or more fields failed validation.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"
}

{
  "status": 429,
  "title": "Rate limit exceeded",
  "detail": "You have exceeded the allowed number of requests. Please try again later.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"
}

PATCH

integrations

{integration_id}

Update an integration

curl --request PATCH \
  --url https://api.arize.com/v2/integrations/{integration_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "LLM",
  "name": "<string>",
  "scopings": [
    {
      "organization_id": "<string>",
      "space_id": "<string>"
    }
  ],
  "config": {
    "api_key": "<string>",
    "is_function_calling_enabled": true,
    "auth": {
      "auth_type": "DEFAULT",
      "role_arn": "<string>",
      "external_id": "<string>",
      "base_url": "<string>"
    },
    "base_url": "<string>",
    "headers": {},
    "is_default_models_enabled": true,
    "model_names": [
      "<string>"
    ],
    "project_id": "<string>",
    "location": "<string>",
    "project_access_label": "<string>"
  }
}
'

import requests

url = "https://api.arize.com/v2/integrations/{integration_id}"

payload = {
    "type": "LLM",
    "name": "<string>",
    "scopings": [
        {
            "organization_id": "<string>",
            "space_id": "<string>"
        }
    ],
    "config": {
        "api_key": "<string>",
        "is_function_calling_enabled": True,
        "auth": {
            "auth_type": "DEFAULT",
            "role_arn": "<string>",
            "external_id": "<string>",
            "base_url": "<string>"
        },
        "base_url": "<string>",
        "headers": {},
        "is_default_models_enabled": True,
        "model_names": ["<string>"],
        "project_id": "<string>",
        "location": "<string>",
        "project_access_label": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'LLM',
    name: '<string>',
    scopings: [{organization_id: '<string>', space_id: '<string>'}],
    config: {
      api_key: '<string>',
      is_function_calling_enabled: true,
      auth: {
        auth_type: 'DEFAULT',
        role_arn: '<string>',
        external_id: '<string>',
        base_url: '<string>'
      },
      base_url: '<string>',
      headers: {},
      is_default_models_enabled: true,
      model_names: ['<string>'],
      project_id: '<string>',
      location: '<string>',
      project_access_label: '<string>'
    }
  })
};

fetch('https://api.arize.com/v2/integrations/{integration_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arize.com/v2/integrations/{integration_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'LLM',
    'name' => '<string>',
    'scopings' => [
        [
                'organization_id' => '<string>',
                'space_id' => '<string>'
        ]
    ],
    'config' => [
        'api_key' => '<string>',
        'is_function_calling_enabled' => true,
        'auth' => [
                'auth_type' => 'DEFAULT',
                'role_arn' => '<string>',
                'external_id' => '<string>',
                'base_url' => '<string>'
        ],
        'base_url' => '<string>',
        'headers' => [
                
        ],
        'is_default_models_enabled' => true,
        'model_names' => [
                '<string>'
        ],
        'project_id' => '<string>',
        'location' => '<string>',
        'project_access_label' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arize.com/v2/integrations/{integration_id}"

	payload := strings.NewReader("{\n  \"type\": \"LLM\",\n  \"name\": \"<string>\",\n  \"scopings\": [\n    {\n      \"organization_id\": \"<string>\",\n      \"space_id\": \"<string>\"\n    }\n  ],\n  \"config\": {\n    \"api_key\": \"<string>\",\n    \"is_function_calling_enabled\": true,\n    \"auth\": {\n      \"auth_type\": \"DEFAULT\",\n      \"role_arn\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"base_url\": \"<string>\"\n    },\n    \"base_url\": \"<string>\",\n    \"headers\": {},\n    \"is_default_models_enabled\": true,\n    \"model_names\": [\n      \"<string>\"\n    ],\n    \"project_id\": \"<string>\",\n    \"location\": \"<string>\",\n    \"project_access_label\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.arize.com/v2/integrations/{integration_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"LLM\",\n  \"name\": \"<string>\",\n  \"scopings\": [\n    {\n      \"organization_id\": \"<string>\",\n      \"space_id\": \"<string>\"\n    }\n  ],\n  \"config\": {\n    \"api_key\": \"<string>\",\n    \"is_function_calling_enabled\": true,\n    \"auth\": {\n      \"auth_type\": \"DEFAULT\",\n      \"role_arn\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"base_url\": \"<string>\"\n    },\n    \"base_url\": \"<string>\",\n    \"headers\": {},\n    \"is_default_models_enabled\": true,\n    \"model_names\": [\n      \"<string>\"\n    ],\n    \"project_id\": \"<string>\",\n    \"location\": \"<string>\",\n    \"project_access_label\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arize.com/v2/integrations/{integration_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"LLM\",\n  \"name\": \"<string>\",\n  \"scopings\": [\n    {\n      \"organization_id\": \"<string>\",\n      \"space_id\": \"<string>\"\n    }\n  ],\n  \"config\": {\n    \"api_key\": \"<string>\",\n    \"is_function_calling_enabled\": true,\n    \"auth\": {\n      \"auth_type\": \"DEFAULT\",\n      \"role_arn\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"base_url\": \"<string>\"\n    },\n    \"base_url\": \"<string>\",\n    \"headers\": {},\n    \"is_default_models_enabled\": true,\n    \"model_names\": [\n      \"<string>\"\n    ],\n    \"project_id\": \"<string>\",\n    \"location\": \"<string>\",\n    \"project_access_label\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "TGxtSW50ZWdyYXRpb246MTI6YUJjRA==",
  "type": "LLM",
  "name": "Production OpenAI",
  "scopings": [
    {
      "organization_id": null,
      "space_id": null
    }
  ],
  "created_at": "2026-02-13T21:27:19.055Z",
  "updated_at": "2026-02-13T21:27:19.279Z",
  "created_by_user_id": "VXNlcjoxOm5OYkM=",
  "config": {
    "provider": "OPEN_AI",
    "has_api_key": true,
    "is_function_calling_enabled": true
  }
}

{
  "status": 400,
  "title": "Invalid request parameters",
  "detail": "The 'name' field is required and must be a non-empty string.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#invalid-request"
}

{
  "status": 401,
  "title": "Authentication required",
  "detail": "You must be authenticated to access this resource.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#authentication-required"
}

{
  "status": 403,
  "title": "Access forbidden",
  "detail": "You do not have permission to access this resource.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#access-forbidden"
}

{
  "status": 404,
  "title": "Resource not found",
  "detail": "The requested resource with ID '12345' was not found.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-not-found"
}

{
  "status": 409,
  "title": "Resource conflict",
  "detail": "A resource with the given identifier already exists.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-conflict"
}

{
  "status": 422,
  "title": "Unprocessable Entity",
  "detail": "One or more fields failed validation.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"
}

{
  "status": 429,
  "title": "Rate limit exceeded",
  "detail": "You have exceeded the allowed number of requests. Please try again later.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"
}

Authorizations

Authorization

string

header

required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Path Parameters

integration_id

string

required

The unique integration identifier. A universally unique identifier (base64-encoded opaque string).

Example:

"RW50aXR5OjEyMzQ1"

Body

application/json

Partially update an integration. The body is discriminated by type. Omitted fields are left unchanged.

Payload Requirements

type is required (it selects the per-type PATCH shape) and is immutable: it must match the stored integration's type, otherwise the request is rejected with 422 (change category by delete + recreate).
At least one updatable field (name, scopings, config, or — for AGENT only — description) must be provided in addition to type. description is not a valid field for type: LLM and is rejected.
For LLM, config.provider is immutable, and config-field applicability is provider-specific (enforced with 422) — see the per-field docs on UpdateLlmConfig.
Envelope and config scalar fields deep-merge: omit = keep, explicit null = clear (for nullable fields).
Collections (scopings, config.model_names, config.headers, config.request_presets) replace the existing values when provided.

Valid example

{
  "type": "LLM",
  "name": "Updated OpenAI",
  "config": { "is_function_calling_enabled": true }
}

Invalid example (empty body)

{}

Option 1
Option 2

PATCH body for an LLM integration. type is required (it selects the union member) and immutable. Provide at least one updatable field (name, scopings, or config) in addition to type. scopings replaces on provide.

type

enum<string>

required

Discriminator. Immutable; must match the integration's type.

Available options:

LLM

name

string

New integration name.

scopings

object[]

Replaces the existing scoping rules.

Show child attributes

config

object

Partial LLM config for PATCH. provider is immutable; if present it must match the stored value. Field applicability is provider-specific and enforced by the handler with 422: api_key and is_function_calling_enabled do not apply to AWS_BEDROCK or VERTEX_AI; auth applies to AWS_BEDROCK only; base_url and headers apply to CUSTOM and NVIDIA_NIM only; is_default_models_enabled and model_names apply to AWS_BEDROCK, CUSTOM, and NVIDIA_NIM only; project_id, location, and project_access_label apply to VERTEX_AI only.

Show child attributes

Response

An integration object.

Option 1
Option 2

An LLM integration (type=LLM).

string

required

The unique identifier for the integration.

type

enum<string>

required

Discriminator identifying an LLM integration.

Available options:

LLM

name

string

required

The integration name. Unique per (account, type).

scopings

object[]

required

Visibility scoping rules. Account-wide when empty.

Show child attributes

created_at

string<date-time>

required

When the integration was created.

updated_at

string<date-time>

required

When the integration was last updated.

created_by_user_id

string

required

Unique identifier of the user who created the integration.

config

object

required

Config for an OpenAI LLM integration.

Show child attributes

Delete an integration List organizations

⌘I

API reference

API clients

Update an integration

Authorizations

Path Parameters

Body

Response