experimental_getRealtimeToolDefinitions

Converts an AI SDK ToolSet into provider-neutral realtime tool definitions that can be passed to a realtime session setup request.

Use it in the server-side setup endpoint that creates a short-lived realtime provider token.

import { openai } from '@ai-sdk/openai';
import { experimental_getRealtimeToolDefinitions, tool } from 'ai';
import { z } from 'zod';

const tools = {
  getWeather: tool({
    description: 'Get the current weather for a city',
    inputSchema: z.object({
      city: z.string(),
    }),
  }),
};

const toolDefinitions = await experimental_getRealtimeToolDefinitions({
  tools,
});

const token = await openai.experimental_realtime.getToken({
  model: 'gpt-realtime',
  sessionConfig: {
    tools: toolDefinitions,
  },
});

Import

import { experimental_getRealtimeToolDefinitions } from "ai"

API Signature

Parameters

• options (Object): The options for converting tools.
  • Object
    • tools (ToolSet): The AI SDK tools to expose to the realtime model. Function and dynamic tools are converted to realtime function definitions. Provider tools are skipped.
    • toolsContext? (InferToolSetContext<TOOLS>): Per-tool context used when resolving dynamic tool descriptions.

Returns

A Promise<Experimental_RealtimeToolDefinition[]>.

Each returned definition contains:

• type ('function'): The realtime tool definition type.
• name (string): The tool name from the input ToolSet.
• description (string | undefined): The tool description sent to the realtime model.
• parameters (JSONSchema7): The JSON schema converted from the tool inputSchema. The realtime model uses this schema to generate tool call arguments.

Notes

• Tool execution is not handled by experimental_getRealtimeToolDefinitions. Use experimental_useRealtime onToolCall and addToolOutput to execute tools and return results.
• Provider tools are skipped because realtime providers expect regular function definitions in the session config.
• Dynamic tool descriptions are resolved with the matching value from toolsContext before the definitions are returned.