For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
ModelsChatRankingsDocs
DocsAPI ReferenceClient SDKsAgent SDKCookbookChangelog
DocsAPI ReferenceClient SDKsAgent SDKCookbookChangelog
    • Overview
    • Usage for Agents
  • TypeScript SDK
    • Overview
      • Analytics
      • APIKeys
      • Byok
      • Chat
      • Credits
      • Embeddings
      • Endpoints
      • Generations
      • Guardrails
      • OAuth
      • Observability
        • SendChatCompletionRequestResponse
      • Organization
      • Presets
      • Providers
      • Rerank
      • Beta.Responses
      • Transcriptions
      • Speech
      • VideoGeneration
      • Workspaces
  • Python SDK
    • Overview
  • Go SDK
  • DevTools
    • Overview
    • Migrating to @openrouter/agent
LogoLogo
ModelsChatRankingsDocs
On this page
  • Supported Types
  • models.ChatResult
  • EventStream<models.ChatStreamingResponse>
TypeScript SDKAPI ReferenceOperations

SendChatCompletionRequestResponse - TypeScript SDK

SendChatCompletionRequestResponse type definition
Was this page helpful?
Previous

Organization - TypeScript SDK

Organization method reference
Next
Built with

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Supported Types

models.ChatResult

1const value: models.ChatResult = {
2 choices: [
3 {
4 finishReason: "stop",
5 index: 0,
6 message: {
7 role: "assistant",
8 },
9 },
10 ],
11 created: 1677652288,
12 id: "chatcmpl-123",
13 model: "openai/gpt-4",
14 object: "chat.completion",
15 systemFingerprint: "fp_44709d6fcb",
16};

EventStream<models.ChatStreamingResponse>