Integrations

Manage LLM and agent integrations programmatically. Create, list, retrieve, update, and delete provider and customer-hosted agent integrations.

The integrations functions are currently in ALPHA. The API may change without notice. A one-time warning is emitted on first use.

Integrations are polymorphic: an LLM integration configures a model provider (e.g. OpenAI, Anthropic), an AGENT integration connects a customer-hosted agent exposed at an HTTPS endpoint, and an EVALUATOR integration connects a customer-hosted HTTPS endpoint used for remote evaluators. The type field ("LLM", "AGENT", or "EVALUATOR") selects the config shape. Integration names are unique per (account, type), so when resolving an integration by name you must also pass its type.

List Integrations

When type is omitted, LLM and AGENT integrations are returned, each carrying its type discriminator. EVALUATOR integrations require an explicit type: "EVALUATOR" filter.

import { listIntegrations } from "@arizeai/ax-client";

// Only agent integrations
const { data: agents, pagination } = await listIntegrations({
  type: "AGENT",       // optional; omit for LLM + AGENT
  space: "my-space",   // space name or ID (optional)
  name: "support",     // substring filter on integration name (optional)
  limit: 10,
});

// LLM and AGENT integrations, discriminated by `integration.type`
const { data: all } = await listIntegrations({});

Create an Integration

The type field selects the config shape: "LLM" for a model-provider integration, "AGENT" for a customer-hosted HTTPS endpoint plus a request JSON Schema, and "EVALUATOR" for a customer-hosted HTTPS endpoint used for remote evaluators. AGENT and EVALUATOR integrations also accept an optional description.

import { createIntegration } from "@arizeai/ax-client";

// LLM integration
const llm = await createIntegration({
  type: "LLM",
  name: "Production OpenAI",
  config: { provider: "OPEN_AI", apiKey: "sk-..." },
});

// Agent integration
const agent = await createIntegration({
  type: "AGENT",
  name: "My Support Agent",
  config: {
    endpoint: "https://agent.example.com/replay",
    inputSchema: { type: "object", properties: { input: { type: "string" } } },
    requestPresets: [{ name: "default", config: { input: "hello" } }],
  },
});

// Evaluator integration
const evaluator = await createIntegration({
  type: "EVALUATOR",
  name: "My Remote Evaluator",
  config: {
    endpoint: "https://evaluator.example.com/evaluate",
    inputSchema: { type: "object", properties: { input: { type: "string" } } },
  },
});

Get an Integration

Resolve by ID, or by name with the required type.

import { getIntegration } from "@arizeai/ax-client";

// By ID
const integration = await getIntegration({ integration: "your_integration_id" });

// By name (requires type)
const integration = await getIntegration({
  integration: "Production OpenAI",
  type: "LLM",
  space: "my-space",  // optional filter when using a name
});

Update an Integration

type is required (it selects the update shape) and is immutable server-side. Provide at least one updatable field. Collection fields (scopings, agent requestPresets) replace on provide.

import { updateIntegration } from "@arizeai/ax-client";

// Rotate an LLM integration's API key by name (provider selects the config
// variant; it is immutable and must match the stored value)
const updated = await updateIntegration({
  integration: "Production OpenAI",
  type: "LLM",
  config: { provider: "OPEN_AI", apiKey: "sk-new-key" },
});

Delete an Integration

Resolve by ID, or by name with the required type. This operation is irreversible.

import { deleteIntegration } from "@arizeai/ax-client";

// By ID
await deleteIntegration({ integration: "your_integration_id" });

// By name (requires type)
await deleteIntegration({ integration: "Production OpenAI", type: "LLM" });