Skip to main content

Integrations

AISIX integrates with developer tools, application frameworks, and AI libraries by replacing the upstream provider endpoint, provider API key, and provider model name with AISIX gateway values. The client keeps its native request shape, while AISIX owns authentication, model aliasing, provider credentials, policy, and telemetry at the gateway boundary.

Use these guides for clients that can send requests to a custom API endpoint, including clients that use OpenAI-compatible Chat Completions, the OpenAI Responses API, or Anthropic-compatible traffic.

This pattern lets teams adopt AISIX without rewriting application code or changing the coding tool itself. The client keeps using its familiar SDK, CLI, or framework, while gateway policy, routing, observability, and provider credentials move into AISIX.

For new OpenAI-family integrations, prefer the client's current recommended API surface when it can still target a custom AISIX base URL. Use the Responses API when the framework provides a first-class Responses client. Use Chat Completions when the client only documents an OpenAI-compatible provider path, or when an existing workflow depends on Chat Completions compatibility.

How Integrations Use AISIX

Most integrations use the same three AISIX values:

  • The proxy API base URL.
  • A caller API key.
  • A model alias that the caller API key can access.

Many clients describe the third value as a custom model, model ID, model name, or public model name. In AISIX, use the model alias for that field. AISIX authenticates the caller key, resolves the alias to an upstream provider configuration, applies configured policies, and records gateway telemetry.

Integration Types

Client typeUse whenGuides
Client SDKsExisting application code uses an OpenAI- or Anthropic-compatible client.OpenAI SDK, Anthropic SDK
Coding agentsA local editor, AI CLI, remote development environment, or automation job should send requests through AISIX.Coding Agents
Frameworks and librariesAn application framework, agent framework, or AI library should call AISIX from application code.LangChain and LangGraph, LlamaIndex, Haystack, Vercel AI SDK, Pydantic AI, Instructor, OpenAI Agents SDK, CrewAI, Microsoft Agent Framework

Prerequisites

Each integration guide assumes the gateway already has the resources needed for the client path:

  • A caller API key for the application, developer, or automation profile.
  • A model alias that the caller API key can access.
  • A proxy API route compatible with the client, such as OpenAI-compatible Chat Completions, the OpenAI Responses API, or Anthropic Messages.

If AISIX is already deployed for your organization, obtain the gateway URL, model alias, and caller API key from the team that manages it. Otherwise, follow the Open-Source AISIX Gateway Quickstart or AISIX Cloud Quickstart, or contact API7 for Hybrid Cloud access.

Provider guides under Models and Providers cover upstream-specific configuration.

Next Steps

  • OpenAI SDK: call an OpenAI-compatible gateway endpoint from application code.
  • Anthropic SDK: call the Anthropic Messages endpoint from application code.
  • Coding Agents: route AI coding tools through AISIX.
  • Supported Endpoints: review the proxy API families available to clients.