Python SDKAPI ReferenceComponents
OpenResponsesResult - Python SDK
OpenResponsesResult - Python SDK
OpenResponsesResult method reference
The Python SDK and docs are currently in beta. Report issues on GitHub.
Complete non-streaming response from the Responses API
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
background | OptionalNullable[bool] | ➖ | N/A | |
completed_at | Nullable[int] | ✔️ | N/A | |
created_at | int | ✔️ | N/A | |
error | Nullable[components.ResponsesErrorField] | ✔️ | Error information returned from the API | {"code": "rate_limit_exceeded","message": "Rate limit exceeded. Please try again later."} |
frequency_penalty | Nullable[float] | ✔️ | N/A | |
id | str | ✔️ | N/A | |
incomplete_details | Nullable[components.IncompleteDetails] | ✔️ | N/A | {"reason": "max_output_tokens"} |
instructions | Nullable[components.BaseInputsUnion] | ✔️ | N/A | [{"content": "What is the weather today?","role": "user"}] |
max_output_tokens | OptionalNullable[int] | ➖ | N/A | |
max_tool_calls | OptionalNullable[int] | ➖ | N/A | |
metadata | Dict[str, str] | ✔️ | 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 | str | ✔️ | N/A | |
object | components.OpenResponsesResultObject | ✔️ | N/A | |
output | List[components.OutputItems] | ✔️ | N/A | |
output_text | Optional[str] | ➖ | N/A | |
parallel_tool_calls | bool | ✔️ | N/A | |
presence_penalty | Nullable[float] | ✔️ | N/A | |
previous_response_id | OptionalNullable[str] | ➖ | N/A | |
prompt | OptionalNullable[components.StoredPromptTemplate] | ➖ | N/A | {"id": "prompt-abc123","variables": {"name": "John"}} |
prompt_cache_key | OptionalNullable[str] | ➖ | N/A | |
reasoning | OptionalNullable[components.BaseReasoningConfig] | ➖ | N/A | {"effort": "medium","summary": "auto"} |
safety_identifier | OptionalNullable[str] | ➖ | N/A | |
service_tier | OptionalNullable[str] | ➖ | N/A | |
status | components.OpenAIResponsesResponseStatus | ✔️ | N/A | completed |
store | Optional[bool] | ➖ | N/A | |
temperature | Nullable[float] | ✔️ | N/A | |
text | Optional[components.TextExtendedConfig] | ➖ | Text output configuration including format and verbosity | {"format": {"type": "text"},“verbosity”: “medium” } |
tool_choice | components.OpenAIResponsesToolChoiceUnion | ✔️ | N/A | auto |
tools | List[components.OpenResponsesResultToolUnion] | ✔️ | N/A | |
top_logprobs | Optional[int] | ➖ | N/A | |
top_p | Nullable[float] | ✔️ | N/A | |
truncation | OptionalNullable[components.Truncation] | ➖ | N/A | auto |
usage | OptionalNullable[components.Usage] | ➖ | Token usage information for the response | {"input_tokens": 100,"input_tokens_details": {"cached_tokens": 0},“output_tokens”: 50, “output_tokens_details”: {"reasoning_tokens": 0},“total_tokens”: 150<br />} |
user | OptionalNullable[str] | ➖ | N/A | |
openrouter_metadata | Optional[components.OpenRouterMetadata] | ➖ | 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” } |