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
        • Models
        • ProviderResponse
      • OAuth
      • Observability
      • 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
  • Example Usage
  • Fields
TypeScript SDKAPI ReferenceModels

ProviderResponse - TypeScript SDK

ProviderResponse type definition
Was this page helpful?
Previous

OAuth - TypeScript SDK

OAuth method reference
Next
Built with

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

Details of a provider response for a generation attempt

Example Usage

1import { ProviderResponse } from "@openrouter/sdk/models";
2
3let value: ProviderResponse = {
4 status: 200,
5};

Fields

FieldTypeRequiredDescriptionExample
endpointIdstring➖Internal endpoint identifierep_abc123
idstring➖Upstream provider response identifierchatcmpl-abc123
isByokboolean➖Whether the request used a bring-your-own-keyfalse
latencynumber➖Response latency in milliseconds1200
modelPermaslugstring➖Canonical model slugopenai/gpt-4
providerNamemodels.ProviderResponseProviderName➖Name of the providerOpenAI
statusnumber✔️HTTP status code from the provider200