# ![Vivgrid logo](https://models.dev/logos/vivgrid.svg)Vivgrid

Access 5 Vivgrid models through Mastra's model router. Authentication is handled automatically using the `VIVGRID_API_KEY` environment variable.

Learn more in the [Vivgrid documentation](https://docs.vivgrid.com/models).

```bash
VIVGRID_API_KEY=your-api-key
```

```typescript
import { Agent } from "@mastra/core/agent";

const agent = new Agent({
  id: "my-agent",
  name: "My Agent",
  instructions: "You are a helpful assistant",
  model: "vivgrid/gemini-3-flash-preview"
});

// Generate a response
const response = await agent.generate("Hello!");

// Stream a response
const stream = await agent.stream("Tell me a story");
for await (const chunk of stream) {
  console.log(chunk);
}
```

> **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Vivgrid documentation](https://docs.vivgrid.com/models) for details.

## Models

| Model                            | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
| -------------------------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
| `vivgrid/gemini-3-flash-preview` | 1.0M    |       |           |       |       |       | $0.50      | $3          |
| `vivgrid/gemini-3-pro-preview`   | 1.0M    |       |           |       |       |       | $2         | $12         |
| `vivgrid/gpt-5.1-codex`          | 400K    |       |           |       |       |       | $1         | $10         |
| `vivgrid/gpt-5.1-codex-max`      | 400K    |       |           |       |       |       | $1         | $10         |
| `vivgrid/gpt-5.2-codex`          | 400K    |       |           |       |       |       | $2         | $14         |

## Advanced Configuration

### Custom Headers

```typescript
const agent = new Agent({
  id: "custom-agent",
  name: "custom-agent",
  model: {
    url: "https://api.vivgrid.com/v1",
    id: "vivgrid/gemini-3-flash-preview",
    apiKey: process.env.VIVGRID_API_KEY,
    headers: {
      "X-Custom-Header": "value"
    }
  }
});
```

### Dynamic Model Selection

```typescript
const agent = new Agent({
  id: "dynamic-agent",
  name: "Dynamic Agent",
  model: ({ requestContext }) => {
    const useAdvanced = requestContext.task === "complex";
    return useAdvanced
      ? "vivgrid/gpt-5.2-codex"
      : "vivgrid/gemini-3-flash-preview";
  }
});
```

## Direct Provider Installation

This provider can also be installed directly as a standalone package, which can be used instead of the Mastra model router string. View the [package documentation](https://www.npmjs.com/package/@ai-sdk/openai) for more details.

**npm**:

```bash
npm install @ai-sdk/openai
```

**pnpm**:

```bash
pnpm add @ai-sdk/openai
```

**Yarn**:

```bash
yarn add @ai-sdk/openai
```

**Bun**:

```bash
bun add @ai-sdk/openai
```