> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aixy-gateway.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Providers

> Connect model accounts, share credentials, and configure project overrides.

A provider connection tells Aixy where to send a model request and which upstream account should
pay for it. Applications keep their Aixy project key when you replace a provider credential.
Use **Providers** to connect accounts, inspect connection checks, and manage credentials.

## Connect a provider

1. Select a project in the sidebar, or **All projects** for an organization connection.
2. Open **Providers → Add provider** and select a provider.
3. Follow the **Setup guide** beside the form for your provider's credentials, permissions, and
   connection fields.
4. Select **Test connection** and review each stage, then save the connection.
5. Open **Models**, select an allowed conversational model, and make a short request in
   [Playground](/gateway/playground).

Owners and Org admins manage shared connections and project overrides. Project admins manage
connections in their assigned projects. Members use the resulting models without receiving the
provider credential.

The provider picker lists built-in integrations and compatible endpoints. Select the connection
that matches your account; region, model entitlement, enabled cloud APIs, and quotas still belong
to that provider account. Connection checks give stage-specific guidance for those requirements.

## Share a connection or override it

An organization connection supplies the default for all projects. A project connection for the
same provider overrides that default, including its endpoint, credential, and cost configuration.
This lets development and production use different provider accounts or regions.

An expired or failing project override remains selected. Replace it to repair the project
connection, or remove it explicitly to restore organization inheritance. See
[How Aixy fits together](/concepts) for the other scope rules.

## Connect an OpenAI-compatible endpoint

Use **Custom endpoint** for a service exposing an OpenAI-compatible API. Its provider ID becomes
part of every model ID: a model named `coding-model` on a connection called `acme` becomes
`acme/coding-model` in Aixy. Keep the full upstream model ID, including any internal slashes.

Aixy uses the saved endpoint for discovery and inference. The endpoint must be publicly reachable
over HTTPS; the dashboard's **Setup guide** explains the connection fields. Use
[Client protocols](/gateway/protocols) to choose the format for application requests.

## Interpret connection checks

A check reports configuration, authentication, and catalog evidence independently. It sends no
prompt. A successful catalog response can come from a public catalog, so verify inference with a
Playground request before adopting a connection. Saving valid configuration and testing network
access are separate actions.

When a credential changes, run a fresh check. Uploaded temporary AWS credentials must be replaced
before expiry; an IAM role lets Aixy renew the temporary session. Vertex service-account connections
let Aixy obtain and renew access tokens using the saved credential.

For spend reporting and streaming usage settings, continue to
[Pricing and cost attribution](/guides/pricing). Provider credentials are separate from
[application API keys](/authentication).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.