Skip to main content
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.
Assistant message for requests and responses

Example Usage

import { ChatAssistantMessage } from "@openrouter/sdk/models";

let value: ChatAssistantMessage = {
  role: "assistant",
};

Fields

FieldTypeRequiredDescriptionExample
audiomodels.ChatAudioOutput:heavy_minus_sign:Audio output data or reference{"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f","expires_at": 1677652400,"id": "audio_abc123","transcript": "Hello! How can I help you today?"}
contentmodels.ChatAssistantMessageContent:heavy_minus_sign:Assistant message content
imagesmodels.ChatAssistantImages[]:heavy_minus_sign:Generated images from image generation models[
{"image_url": {"url": "data:image/png;base64,iVBORw0KGgo..."}
}
]
namestring:heavy_minus_sign:Optional name for the assistant
reasoningstring:heavy_minus_sign:Reasoning output
reasoningDetailsmodels.ReasoningDetailUnion[]:heavy_minus_sign:Reasoning details for extended thinking models[
{"thinking": "Let me work through this step by step...","type": "thinking"}
]
refusalstring:heavy_minus_sign:Refusal message if content was refused
rolemodels.ChatAssistantMessageRole:heavy_check_mark:N/A
toolCallsmodels.ChatToolCall[]:heavy_minus_sign:Tool calls made by the assistant