Apertis Docs
Apertis Docs

SDKs & Libraries

@apertis/ai-sdk-provider

Official Vercel AI SDK Provider for Apertis, enabling access to the models available to your Apertis API key through a standardized AI SDK interface.

Updated
Reading time
1 min
Ask ClaudeAsk ChatGPTOpen in Cursor
View as Markdown

On this page

Installation

npm install @apertis/ai-sdk-provider ai

Or using other package managers:

# pnpm
pnpm add @apertis/ai-sdk-provider ai

# yarn
yarn add @apertis/ai-sdk-provider ai

Setup

  1. Create an Apertis account.
  2. Create an API key from Apertis Keys.

Environment Variable

export APERTIS_API_KEY=sk-your-api-key

Code Configuration

import { createApertis } from '@apertis/ai-sdk-provider';

const apertis = createApertis({
  apiKey: process.env.APERTIS_API_KEY,
});

Usage Examples

Basic Text Generation

import { apertis } from '@apertis/ai-sdk-provider';
import { generateText } from 'ai';

const { text } = await generateText({
  model: apertis('gpt-5.2'),
  prompt: 'Explain quantum computing in simple terms.',
});

console.log(text);

Streaming

import { apertis } from '@apertis/ai-sdk-provider';
import { streamText } from 'ai';

const { textStream } = await streamText({
  model: apertis('claude-sonnet-4.5'),
  prompt: 'Write a poem about programming.',
});

for await (const chunk of textStream) {
  process.stdout.write(chunk);
}

Tool Calling (Function Calling)

import { apertis } from '@apertis/ai-sdk-provider';
import { generateText, tool } from 'ai';
import { z } from 'zod';

const { text } = await generateText({
  model: apertis('gpt-5.2'),
  tools: {
    weather: tool({
      description: 'Get weather information for a location',
      parameters: z.object({ location: z.string() }),
      execute: async ({ location }) => `Sunny, 22°C in ${location}`,
    }),
  },
  prompt: 'What is the weather in Tokyo?',
});

Embeddings

import { apertis } from '@apertis/ai-sdk-provider';
import { embed, embedMany } from 'ai';

// Single embedding
const { embedding } = await embed({
  model: apertis.textEmbeddingModel('text-embedding-3-small'),
  value: 'Hello world',
});

// Batch embeddings
const { embeddings } = await embedMany({
  model: apertis.textEmbeddingModel('text-embedding-3-large', {
    dimensions: 1024, // Optional: reduce dimensions
  }),
  values: ['Hello', 'World'],
});

Supported Models

Access models from multiple providers through Apertis. Model availability changes over time and can vary by key type, so use GET /v1/models as the source of truth.

Chat Models

  • OpenAI: gpt-5.2, gpt-4.1-mini
  • Anthropic: claude-sonnet-4.5, claude-haiku-4.5
  • Google: gemini-2.5-flash

The examples above are illustrative. Query the model catalog before pinning an ID in production.

Embedding Models

  • text-embedding-3-small
  • text-embedding-3-large
  • text-embedding-ada-002

Context Compression

Enable context compression via custom headers to reduce token usage for long conversations:

import { createApertis } from '@apertis/ai-sdk-provider';
import { generateText } from 'ai';

const apertis = createApertis({
  apiKey: process.env.APERTIS_API_KEY,
  headers: {
    'X-Context-Compression': 'on',
    'X-Compression-Model': 'gpt-4.1-mini',
  },
});

const { text } = await generateText({
  model: apertis('gpt-4.1'),
  messages: [
    { role: 'user', content: 'Explain distributed systems' },
    { role: 'assistant', content: 'Distributed systems are...' },
    // ... long conversation history ...
    { role: 'user', content: 'Summarize the key points' },
  ],
});

Advanced Configuration

import { createApertis } from '@apertis/ai-sdk-provider';

const apertis = createApertis({
  apiKey: 'sk-your-api-key',           // API Key
  baseURL: 'https://api.apertis.ai/v1', // API endpoint
  headers: { 'X-Custom': 'value' },     // Custom headers
});

Resources