Vercel AI SDK Integration

Get Your Nordlys API Key

Overview

The Vercel AI SDK works seamlessly with Nordlys through two methods:

Nordlys SDK (Recommended): Use the native @nordlys-llm/nordlys-ai-provider package.
OpenAI-Compatible Client: Use Nordlys via @ai-sdk/openai with a custom base URL.

Method 1: Nordlys SDK

Installation

npm install ai @nordlys-llm/nordlys-ai-provider

yarn add ai @nordlys-llm/nordlys-ai-provider

pnpm add ai @nordlys-llm/nordlys-ai-provider

bun add ai @nordlys-llm/nordlys-ai-provider

Basic Setup

import { nordlys } from "@nordlys-llm/nordlys-ai-provider";

// Use default configuration
const model = nordlys();

import { createNordlys } from "@nordlys-llm/nordlys-ai-provider";

const customNordlys = createNordlys({
  baseURL: "https://api.nordlyslabs.com/v1",
  apiKey: process.env.NORDLYS_API_KEY,
  headers: {
    "User-Agent": "MyApp/1.0",
  },
});

Method 2: OpenAI-Compatible Client

Installation

npm install ai @ai-sdk/openai

yarn add ai @ai-sdk/openai

pnpm add ai @ai-sdk/openai

bun add ai @ai-sdk/openai

Configuration

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

const nordlysOpenAI = openai({
  apiKey: process.env.NORDLYS_API_KEY,
  baseURL: 'https://api.nordlyslabs.com/v1',
});

const { text } = await generateText({
  model: nordlysOpenAI('nordlys/hypernova'),
  prompt: 'Explain quantum computing simply',
});

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

const nordlysOpenAI = openai({
  apiKey: process.env.NORDLYS_API_KEY!,
  baseURL: 'https://api.nordlyslabs.com/v1',
});

const { text } = await generateText({
  model: nordlysOpenAI('nordlys/hypernova'),
  prompt: 'Explain quantum computing simply',
});

console.log(text);

Text Generation

import { generateText } from 'ai';
import { nordlys } from '@nordlys-llm/nordlys-ai-provider';

const { text } = await generateText({
  model: nordlys(),
  prompt: 'Write a vegetarian lasagna recipe for 4 people.',
});

import { generateText } from 'ai';

const { text } = await generateText({
  model: nordlysOpenAI('nordlys/hypernova'),
  prompt: 'Write a vegetarian lasagna recipe for 4 people.',
});

Streaming

import { streamText } from 'ai';
import { nordlys } from '@nordlys-llm/nordlys-ai-provider';

const { textStream } = await streamText({
  model: nordlys(),
  prompt: 'Explain machine learning step by step',
});

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

import { streamText } from 'ai';

const { textStream } = await streamText({
  model: nordlysOpenAI('nordlys/hypernova'),
  prompt: 'Explain machine learning step by step',
});

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

React Chat Component

import { useChat } from 'ai/react';

export default function Chat() {
  const { messages, input, handleInputChange, handleSubmit } = useChat({
    api: '/api/chat', // Your API route using Nordlys
  });

  return (
    <div>
      {messages.map(m => (
        <div key={m.id}>
          <strong>{m.role}: </strong>
          {m.content}
        </div>
      ))}
      
      <form onSubmit={handleSubmit}>
        <input
          value={input}
          placeholder="Say something..."
          onChange={handleInputChange}
        />
        <button type="submit">Send</button>
      </form>
    </div>
  );
}

// pages/api/chat.js or app/api/chat/route.js
import { nordlys } from '@nordlys-llm/nordlys-ai-provider';
import { streamText } from 'ai';

export async function POST(req) {
  const { messages } = await req.json();

  const result = await streamText({
    model: nordlys(),
    messages,
  });

  return result.toDataStreamResponse();
}

// pages/api/chat.js or app/api/chat/route.js
import { openai } from '@ai-sdk/openai';
import { streamText } from 'ai';

const nordlysOpenAI = openai({
  apiKey: process.env.NORDLYS_API_KEY,
  baseURL: 'https://api.nordlyslabs.com/v1',
});

export async function POST(req) {
  const { messages } = await req.json();

  const result = await streamText({
    model: nordlysOpenAI('nordlys/hypernova'),
    messages,
  });

  return result.toDataStreamResponse();
}

Configuration

Nordlys keeps advanced tuning internal. Use a Nordlys model ID and focus on your product logic.

Tool/Function Calling

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

const { text } = await generateText({
  model: nordlys(),
  prompt: "What's the weather in New York?",
  tools: {
    getWeather: tool({
      description: 'Get weather for a location',
      parameters: z.object({
        location: z.string(),
      }),
      execute: async ({ location }) => {
        return `Weather in ${location} is sunny and 72°F`;
      },
    }),
  },
});

import { generateText, tool } from 'ai';
import { z } from 'zod';

const { text } = await generateText({
  model: nordlysOpenAI('nordlys/hypernova'),
  prompt: "What's the weather in New York?",
  tools: {
    getWeather: tool({
      description: 'Get weather for a location',
      parameters: z.object({
        location: z.string(),
      }),
      execute: async ({ location }) => {
        return `Weather in ${location} is sunny and 72°F`;
      },
    }),
  },
});

Environment Variables

Environment Setup

# .env.local
NORDLYS_API_KEY=your-nordlys-api-key

Error Handling

Nordlys retries transient errors automatically. For comprehensive error handling patterns, see the Error Handling Guide.

import { useChat } from 'ai/react';

export default function Chat() {
  const { messages, input, handleInputChange, handleSubmit, error, reload } = useChat({
    api: '/api/chat',
    onError: (error) => {
      console.error('Nordlys chat error:', error);
    },
  });

  return (
    <div>
      {/* Your chat UI */}
      {error && (
        <div className="error">
          {error.message}
          <button onClick={() => reload()}>Retry</button>
        </div>
      )}
    </div>
  );
}

What You Get

Mixture of Models Activation

The right specialists activate per prompt

Built-in Streaming

Real-time response streaming with React components

Cost Optimization

Significant cost savings through lab‑tuned models

Response Metadata

Inspect latency and quality signals per request

Next Steps

More Examples

See complete working examples

API Reference

Explore all available options and parameters

Getting Started

Developer Tools

Framework Integrations

API Reference

Support

Vercel AI SDK Integration

Get Your Nordlys API Key

Overview

Method 1: Nordlys SDK

Installation

Basic Setup

Method 2: OpenAI-Compatible Client

Installation

Configuration

Text Generation

Streaming

React Chat Component

Configuration

Tool/Function Calling

Environment Variables

Error Handling

What You Get

Mixture of Models Activation

Built-in Streaming

Cost Optimization

Response Metadata

Next Steps

More Examples

API Reference

​Get Your Nordlys API Key

​Overview

​Method 1: Nordlys SDK

​Installation

​Basic Setup

​Method 2: OpenAI-Compatible Client

​Installation

​Configuration

​Text Generation

​Streaming

​React Chat Component

​Configuration

​Tool/Function Calling

​Environment Variables

​Error Handling

​What You Get

Mixture of Models Activation

Built-in Streaming

Cost Optimization

Response Metadata

​Next Steps

More Examples

API Reference

Get Your Nordlys API Key

Overview

Method 1: Nordlys SDK

Installation

Basic Setup

Method 2: OpenAI-Compatible Client

Installation

Configuration

Text Generation

Streaming

React Chat Component

Configuration

Tool/Function Calling

Environment Variables

Error Handling

What You Get

Next Steps