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

# OpenAI Compatible Provider

> Use any OpenAI-compatible API with PraisonAI TypeScript

```mermaid theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
graph LR
    U[Input] --> A[Agent]
    A --> O[Output]

    classDef agent fill:#8B0000,color:#fff
    classDef tool fill:#189AB4,color:#fff

    class A agent
    class U,O tool
```

# OpenAI Compatible Provider

Connect to any OpenAI-compatible API endpoint.

## Environment Variables

```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
export OPENAI_COMPATIBLE_API_KEY=...
export OPENAI_COMPATIBLE_BASE_URL=https://api.example.com/v1
```

## Quick Start

**1. Simple Usage**

```typescript theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
import { Agent } from 'praisonai';

const agent = new Agent({
  name: 'CompatibleAgent',
  instructions: 'You are a helpful assistant.',
  llm: 'openai-compatible/my-model',
  llmConfig: {
    baseUrl: 'https://api.example.com/v1',
    apiKey: process.env.OPENAI_COMPATIBLE_API_KEY
  }
});

const response = await agent.chat('Hello!');
```

**2. With Configuration**

Adjust provider credentials and model settings for production — see the sections above.

## Compatible Services

* vLLM
* LocalAI
* Text Generation Inference
* Anyscale
* Custom deployments

## Related

> [card] [OpenAI Compatible CLI Usage](https://praison.ai/docs/js/providers/openai-compatible-cli.md)
>
> OpenAI Compatible CLI Usage


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