Skip to main content
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.
Complete non-streaming response from the Responses API

Example Usage

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

let value: OpenResponsesNonStreamingResponse = {
  id: "resp-abc123",
  object: "response",
  createdAt: 1704067200,
  model: "gpt-4",
  status: "completed",
  completedAt: null,
  output: [
    {
      id: "msg-abc123",
      role: "assistant",
      type: "message",
      content: [
        {
          type: "output_text",
          text: "Hello! How can I help you today?",
        },
      ],
    },
  ],
  error: null,
  incompleteDetails: null,
  temperature: null,
  topP: null,
  presencePenalty: 293.66,
  frequencyPenalty: 9884.38,
  instructions: null,
  metadata: null,
  tools: [],
  toolChoice: "auto",
  parallelToolCalls: true,
};

Fields

FieldTypeRequiredDescriptionExample
idstring:heavy_check_mark:N/A
objectmodels.ObjectT:heavy_check_mark:N/A
createdAtnumber:heavy_check_mark:N/A
modelstring:heavy_check_mark:N/A
statusmodels.OpenAIResponsesResponseStatus:heavy_check_mark:N/A
completedAtnumber:heavy_check_mark:N/A
outputmodels.ResponsesOutputItem[]:heavy_check_mark:N/A
userstring:heavy_minus_sign:N/A
outputTextstring:heavy_minus_sign:N/A
promptCacheKeystring:heavy_minus_sign:N/A
safetyIdentifierstring:heavy_minus_sign:N/A
errormodels.ResponsesErrorField:heavy_check_mark:Error information returned from the API{"code": "rate_limit_exceeded","message": "Rate limit exceeded. Please try again later."}
incompleteDetailsmodels.OpenAIResponsesIncompleteDetails:heavy_check_mark:N/A
usagemodels.OpenResponsesUsage:heavy_minus_sign:Token usage information for the response{"input_tokens": 10,"output_tokens": 25,"total_tokens": 35,"input_tokens_details": {"cached_tokens": 0},
“output_tokens_details”: {"reasoning_tokens": 0},
“cost”: 0.0012,
“cost_details”: {"upstream_inference_cost": null,"upstream_inference_input_cost": 0.0008,"upstream_inference_output_cost": 0.0004}
}
maxToolCallsnumber:heavy_minus_sign:N/A
topLogprobsnumber:heavy_minus_sign:N/A
maxOutputTokensnumber:heavy_minus_sign:N/A
temperaturenumber:heavy_check_mark:N/A
topPnumber:heavy_check_mark:N/A
presencePenaltynumber:heavy_check_mark:N/A
frequencyPenaltynumber:heavy_check_mark:N/A
instructionsmodels.OpenAIResponsesInputUnion:heavy_check_mark:N/A
metadataRecord<string, *string*>:heavy_check_mark:Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed.{"user_id": "123","session_id": "abc-def-ghi"}
toolsmodels.OpenResponsesNonStreamingResponseToolUnion[]:heavy_check_mark:N/A
toolChoicemodels.OpenAIResponsesToolChoiceUnion:heavy_check_mark:N/A
parallelToolCallsboolean:heavy_check_mark:N/A
promptmodels.OpenAIResponsesPrompt:heavy_minus_sign:N/A
backgroundboolean:heavy_minus_sign:N/A
previousResponseIdstring:heavy_minus_sign:N/A
reasoningmodels.OpenAIResponsesReasoningConfig:heavy_minus_sign:N/A
serviceTiermodels.OpenAIResponsesServiceTier:heavy_minus_sign:N/A
storeboolean:heavy_minus_sign:N/A
truncationmodels.OpenAIResponsesTruncation:heavy_minus_sign:N/A
textmodels.ResponseTextConfig:heavy_minus_sign:Text output configuration including format and verbosity{"format": {"type": "text"},
“verbosity”: “medium”
}