Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
Background | optionalnullable.OptionalNullable[bool] | :heavy_minus_sign: | N/A | |
CompletedAt | *int64 | :heavy_check_mark: | N/A | |
CreatedAt | int64 | :heavy_check_mark: | N/A | |
Error | *components.ResponsesErrorField | :heavy_check_mark: | Error information returned from the API | {"code": "rate_limit_exceeded","message": "Rate limit exceeded. Please try again later."} |
FrequencyPenalty | *float64 | :heavy_check_mark: | N/A | |
ID | string | :heavy_check_mark: | N/A | |
IncompleteDetails | *components.IncompleteDetails | :heavy_check_mark: | N/A | {"reason": "max_output_tokens"} |
Instructions | *components.BaseInputsUnion | :heavy_check_mark: | N/A | [{"content": "What is the weather today?","role": "user"}] |
MaxOutputTokens | optionalnullable.OptionalNullable[int64] | :heavy_minus_sign: | N/A | |
MaxToolCalls | optionalnullable.OptionalNullable[int64] | :heavy_minus_sign: | N/A | |
Metadata | map[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. | {"session_id": "abc-def-ghi","user_id": "123"} |
Model | string | :heavy_check_mark: | N/A | |
Object | components.OpenResponsesResultObject | :heavy_check_mark: | N/A | |
Output | []components.OutputItems | :heavy_check_mark: | N/A | |
OutputText | *string | :heavy_minus_sign: | N/A | |
ParallelToolCalls | bool | :heavy_check_mark: | N/A | |
PresencePenalty | *float64 | :heavy_check_mark: | N/A | |
PreviousResponseID | optionalnullable.OptionalNullable[string] | :heavy_minus_sign: | N/A | |
Prompt | optionalnullable.OptionalNullable[components.StoredPromptTemplate] | :heavy_minus_sign: | N/A | {"id": "prompt-abc123","variables": {"name": "John"}} |
PromptCacheKey | optionalnullable.OptionalNullable[string] | :heavy_minus_sign: | N/A | |
Reasoning | optionalnullable.OptionalNullable[components.BaseReasoningConfig] | :heavy_minus_sign: | N/A | {"effort": "medium","summary": "auto"} |
SafetyIdentifier | optionalnullable.OptionalNullable[string] | :heavy_minus_sign: | N/A | |
ServiceTier | optionalnullable.OptionalNullable[string] | :heavy_minus_sign: | N/A | |
Status | components.OpenAIResponsesResponseStatus | :heavy_check_mark: | N/A | completed |
Store | *bool | :heavy_minus_sign: | N/A | |
Temperature | *float64 | :heavy_check_mark: | N/A | |
Text | *components.TextExtendedConfig | :heavy_minus_sign: | Text output configuration including format and verbosity | {"format": {"type": "text"}} |
ToolChoice | components.OpenAIResponsesToolChoiceUnion | :heavy_check_mark: | N/A | auto |
Tools | []components.OpenResponsesResultToolUnion | :heavy_check_mark: | N/A | |
TopLogprobs | *int64 | :heavy_minus_sign: | N/A | |
TopP | *float64 | :heavy_check_mark: | N/A | |
Truncation | optionalnullable.OptionalNullable[components.Truncation] | :heavy_minus_sign: | N/A | auto |
Usage | optionalnullable.OptionalNullable[components.Usage] | :heavy_minus_sign: | Token usage information for the response | {"cost": 0.0012,"cost_details": {"upstream_inference_cost": null,"upstream_inference_input_cost": 0.0008,"upstream_inference_output_cost": 0.0004},“input_tokens”: 10, “input_tokens_details”: {"cached_tokens": 0},“output_tokens”: 25, “output_tokens_details”: {"reasoning_tokens": 0},“total_tokens”: 35<br/>} |
User | optionalnullable.OptionalNullable[string] | :heavy_minus_sign: | N/A | |
OpenrouterMetadata | *components.OpenRouterMetadata | :heavy_minus_sign: | N/A | {"attempt": 1,"endpoints": {"available": [{"model": "openai/gpt-4o","provider": "OpenAI","selected": true}], “total”: 1<br/>},“is_byok”: false, “region”: “iad”, “requested”: “openai/gpt-4o”, “strategy”: “direct”, “summary”: “available=1, selected=OpenAI” } |