GenerationResponseData Type | OpenRouter TypeScript SDK | OpenRouter

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

Generation data

Example Usage

1 import { GenerationResponseData } from "@openrouter/sdk/models";
2 
3 let value: GenerationResponseData = {
4   apiType: "tts",
5   appId: 12345,
6   cacheDiscount: 0.0002,
7   cancelled: false,
8   createdAt: "2024-07-15T23:33:19.433273+00:00",
9   dataRegion: "global",
10   externalUser: "user-123",
11   finishReason: "stop",
12   generationTime: 1200,
13   httpReferer: "<value>",
14   id: "gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG",
15   isByok: false,
16   latency: 1250,
17   model: "sao10k/l3-stheno-8b",
18   moderationLatency: 50,
19   nativeFinishReason: "stop",
20   nativeTokensCached: 3,
21   nativeTokensCompletion: 25,
22   nativeTokensCompletionImages: 0,
23   nativeTokensPrompt: 10,
24   nativeTokensReasoning: 5,
25   numFetches: 0,
26   numInputAudioPrompt: 0,
27   numMediaCompletion: 0,
28   numMediaPrompt: 1,
29   numSearchResults: 5,
30   origin: "https://openrouter.ai/",
31   presetId: "a9e8d400-592a-494f-908c-375efa66cafd",
32   providerName: "Infermatic",
33   providerResponses: [
34     {
35       status: 200,
36     },
37   ],
38   router: "openrouter/auto",
39   serviceTier: "priority",
40   streamed: true,
41   tokensCompletion: 25,
42   tokensPrompt: 10,
43   totalCost: 0.0015,
44   upstreamId: "chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946",
45   upstreamInferenceCost: 0.0012,
46   usage: 0.0015,
47   userAgent: "<value>",
48   webSearchEngine: "exa",
49 };

Fields

Field	Type	Required	Description	Example
`apiType`	models.ApiType	✔️	Type of API used for the generation
`appId`	number	✔️	ID of the app that made the request	12345
`cacheDiscount`	number	✔️	Discount applied due to caching	0.0002
`cancelled`	boolean	✔️	Whether the generation was cancelled	false
`createdAt`	string	✔️	ISO 8601 timestamp of when the generation was created	2024-07-15T23:33:19.433273+00:00
`dataRegion`	models.DataRegion	✔️	The data region this generation was routed through. ‘europe’ for EU-routed requests, ‘global’ otherwise.	global
`externalUser`	string	✔️	External user identifier	user-123
`finishReason`	string	✔️	Reason the generation finished	stop
`generationTime`	number	✔️	Time taken for generation in milliseconds	1200
`httpReferer`	string	✔️	Referer header from the request
`id`	string	✔️	Unique identifier for the generation	gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG
`isByok`	boolean	✔️	Whether this used bring-your-own-key	false
`latency`	number	✔️	Total latency in milliseconds	1250
`model`	string	✔️	Model used for the generation	sao10k/l3-stheno-8b
`moderationLatency`	number	✔️	Moderation latency in milliseconds	50
`nativeFinishReason`	string	✔️	Native finish reason as reported by provider	stop
`nativeTokensCached`	number	✔️	Native cached tokens as reported by provider	3
`nativeTokensCompletion`	number	✔️	Native completion tokens as reported by provider	25
`nativeTokensCompletionImages`	number	✔️	Native completion image tokens as reported by provider	0
`nativeTokensPrompt`	number	✔️	Native prompt tokens as reported by provider	10
`nativeTokensReasoning`	number	✔️	Native reasoning tokens as reported by provider	5
`numFetches`	number	✔️	Number of web fetches performed	0
`numInputAudioPrompt`	number	✔️	Number of audio inputs in the prompt	0
`numMediaCompletion`	number	✔️	Number of media items in the completion	0
`numMediaPrompt`	number	✔️	Number of media items in the prompt	1
`numSearchResults`	number	✔️	Number of search results included	5
`origin`	string	✔️	Origin URL of the request	https://openrouter.ai/
`presetId`	string	✔️	ID of the preset used for this generation, null if no preset was used	a9e8d400-592a-494f-908c-375efa66cafd
`providerName`	string	✔️	Name of the provider that served the request	Infermatic
`providerResponses`	models.ProviderResponse[]	✔️	List of provider responses for this generation, including fallback attempts
`requestId`	string	➖	Unique identifier grouping all generations from a single API request	req-1727282430-aBcDeFgHiJkLmNoPqRsT
`responseCacheSourceId`	string	➖	If this generation was served from response cache, contains the original generation ID. Null otherwise.
`router`	string	✔️	Router used for the request (e.g., openrouter/auto)	openrouter/auto
`serviceTier`	string	✔️	Service tier the upstream provider reported running this request on, or null if it did not report one.	priority
`sessionId`	string	➖	Session identifier grouping multiple generations in the same session
`streamed`	boolean	✔️	Whether the response was streamed	true
`tokensCompletion`	number	✔️	Number of tokens in the completion	25
`tokensPrompt`	number	✔️	Number of tokens in the prompt	10
`totalCost`	number	✔️	Total cost of the generation in USD	0.0015
`upstreamId`	string	✔️	Upstream provider’s identifier for this generation	chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946
`upstreamInferenceCost`	number	✔️	Cost charged by the upstream provider	0.0012
`usage`	number	✔️	Usage amount in USD	0.0015
`userAgent`	string	✔️	User-Agent header from the request
`webSearchEngine`	string	✔️	The resolved web search engine used for this generation (e.g. exa, firecrawl, parallel)	exa