Retrieve a response

GET

https://ap-southeast-1.maas.qwencloudapi.com/compatible-mode/v1/responses/{response_id}

Python

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    # Singapore (ap-southeast-1). For another region, replace ap-southeast-1 in the URL.
    # API keys are region-specific. See https://docs.qwencloud.com/developer-guides/getting-started/regions
    base_url="https://ap-southeast-1.maas.qwencloudapi.com/compatible-mode/v1",
)

response = client.responses.retrieve("resp_xxx")
print(response)

{
  "background": false,
  "completed_at": 1778676420,
  "created_at": 1778676418,
  "frequency_penalty": 0,
  "id": "resp_801bc2c4-93d9-910f-b35d-5274f5a737c1",
  "metadata": {},
  "model": "qwen-plus",
  "object": "response",
  "output": [
    {
      "content": [
        {
          "annotations": [],
          "text": "Hello! Nice to meet you. How can I help you today?",
          "type": "output_text"
        }
      ],
      "id": "msg_8c54756c-9b65-4a95-81d7-4276d91406db",
      "role": "assistant",
      "status": "completed",
      "type": "message"
    }
  ],
  "parallel_tool_calls": true,
  "presence_penalty": 0,
  "service_tier": "default",
  "status": "completed",
  "store": true,
  "temperature": 1,
  "tool_choice": "auto",
  "tools": [],
  "tool_usage": {},
  "top_logprobs": 0,
  "top_p": 1,
  "usage": {
    "input_tokens": 45,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 63,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 108
  }
}

Authorizations

string

header

required

DashScope API key.

Path Parameters

string

required

The ID of the response to retrieve, in the format resp_xxx. You can obtain it from the create-response API. Only response IDs returned by requests created with store=true can be retrieved.

Response

200-application/json

string

The unique ID for this response. It is valid for 7 days. You can use this parameter in the previous_response_id parameter to create a multi-turn conversation.

number

The Unix timestamp in seconds for this request.

enum<string>

The object type. The value is response.

Available options:response

enum<string>

The status of the response generation.

Available options:completed,failed,in_progress,cancelled,queued,incomplete

string

The ID of the model that is used to generate the response.

object[]

An array of output items generated by the model. The type and order of elements in the array depend on the model's response.

Show child attributes

enum<string>

The type of the output item.

message: Contains the final reply content generated by the model.
reasoning: Returned when thinking mode (enable_thinking: true) is enabled. Reasoning tokens are counted in output_tokens_details.reasoning_tokens and are billed as reasoning tokens.
function_call: Returned when a user-defined function tool is used. You need to handle the function call and return the result.
web_search_call: Returned when the web_search tool is used.
code_interpreter_call: Returned when the code_interpreter tool is used.
web_extractor_call: Returned when the web_extractor tool is used. It must be used with the web_search tool.
web_search_image_call: Returned when the web_search_image tool is used. It contains a list of searched images.
image_search_call: Returned when the image_search tool is used. It contains a list of similar images.
mcp_call: Returned when the mcp tool is used. It contains the result of the MCP service call.
file_search_call: Returned when the file_search tool is used. It contains the search query and results from the knowledge base.

Available options:message,reasoning,function_call,web_search_call,code_interpreter_call,web_extractor_call,web_search_image_call,image_search_call,mcp_call,file_search_call

string

The unique identifier for the output item. This field is included in all types of output items.

enum<string>

The role of the message. The value is assistant. This field exists only when the type is message.

Available options:assistant

enum<string>

The status of the output item.

Available options:completed,in_progress

string

The tool or function name. This field exists when the type is function_call, web_search_image_call, image_search_call, or mcp_call. For web_search_image_call and image_search_call, the values are fixed as web_search_image and image_search, respectively. For mcp_call, the value is the specific function name called in the MCP service, such as amap-maps-maps_geo.

string

The arguments for the tool call, in JSON string format. This field exists when the type is function_call, web_search_image_call, image_search_call, or mcp_call. You need to parse it using JSON.parse() before use.

Arguments content by tool type:

web_search_image_call: {"queries": ["search term 1", "search term 2"]}, where queries is a list of search terms auto-generated by the model.
image_search_call: {"img_idx": 0, "bbox": [0, 0, 1000, 1000]}, where img_idx is the index of the input image (starting from 0), and bbox is the bounding box coordinates [x1, y1, x2, y2] for the search area, with a range of 0-1000.
function_call: An argument object generated according to the schema of the user-defined function parameters.
mcp_call: An argument object for the function called in the MCP service.

string

The unique identifier for the function call. This field exists only when the type is function_call. When returning the function call result, you must use this ID to associate the request with the response.

object[]

An array of message content. This field exists only when the type is message.

Show child attributes

enum<string>

The content type. The value is output_text.

Available options:output_text

string

The text content that is generated by the model.

object[]

An array of text annotations. This is usually an empty array.

object[]

An array of reasoning summaries. This field exists only when the type is reasoning. Each element contains a type field with a value of summary_text and a text field that contains the summary text.

Show child attributes

enum<string>

Available options:summary_text

string

object

The search action information. This field exists only when the type is web_search_call.

Show child attributes

string

The search query keyword.

enum<string>

The search type. The value is search.

Available options:search

object[]

A list of search sources. Each element contains a type field and a url field.

Show child attributes

string

The code that is generated and executed by the model. This field exists only when the type is code_interpreter_call.

object[]

An array of code execution outputs. This field exists only when the type is code_interpreter_call. Each element contains a type field with a value of logs and a logs field that contains the code execution log.

Show child attributes

enum<string>

Available options:logs

string

The identifier for the code interpreter container. This field exists only when the type is code_interpreter_call. It is used to associate multiple code executions within the same session.

string

A description of the extraction goal that explains what information needs to be extracted from the web page. This field exists only when the type is web_extractor_call.

string

The output result of the tool call, in string format.

When type is web_extractor_call, this is the summary of the extracted web content.
When type is web_search_image_call or image_search_call, this is a JSON string containing an array of image search results. Each element contains a title field (image title), a url field (image URL), and an index field (sequence number).
When type is mcp_call, this is the JSON string result returned by the MCP service.

string[]

A list of URLs of the extracted web pages. This field exists only when the type is web_extractor_call.

string

The MCP service label. This field exists only when the type is mcp_call. It identifies the MCP service used for this call.

string[]

The list of queries used for knowledge base retrieval. This field exists only when the type is file_search_call. Array elements are strings representing search queries generated by the model.

object[]

An array of knowledge base retrieval results. This field exists only when the type is file_search_call.

Show child attributes

string

The file ID of the matching document.

string

The filename of the matching document.

number

The relevance score of the match, ranging from 0 to 1. A higher value indicates greater relevance.

string

A snippet of the matched document content.

boolean

Whether parallel tool calls are enabled.

string

The value of the tool_choice parameter from the echo request. Valid values are auto, none, and required.

object[]

The complete content of the tools parameter from the echo request. The structure is the same as the tools parameter in the request body.

object | null

The error object that is returned when the model fails to generate a response. This field is null on success.

Show child attributes

string

The error code.

string

A human-readable error message.

object

Tool usage statistics for this request, recorded separately from model token usage in usage. When no tools are called, this field defaults to an empty object {}.

Show child attributes

object

Usage of the web search tool.

Show child attributes

integer

The number of billable searches.

object

Usage of the code interpreter tool.

Show child attributes

integer

The number of code interpreter executions.

object

Usage of the web page extraction tool.

Show child attributes

integer

The number of web page content extraction requests.

object

Usage of the image-to-image search tool.

Show child attributes

integer

The number of image-to-image searches.

object

Usage of the text-to-image search tool.

Show child attributes

integer

The number of text-to-image searches.

object

Usage of the PDF page parsing tool.

Show child attributes

integer

The number of PDF pages parsed.

object

The token consumption information for this request.

Show child attributes

integer

The number of input tokens.

integer

The number of tokens that are output by the model.

integer

The total number of tokens consumed. This is the sum of input_tokens and output_tokens.

object

The fine-grained categorization of input tokens.

Show child attributes

integer

The number of tokens that hit the cache.

object

The fine-grained categorization of output tokens.

Show child attributes

integer

The number of tokens in the thinking process.

object[]

Detailed token breakdown by billing type.

Show child attributes

integer

The number of input tokens.

integer

The number of tokens output by the model.

integer

The total number of tokens consumed, the sum of input_tokens and output_tokens.

string

Fixed as response_api.

integer

The number of image input tokens. Returned when image input is included, equivalent to input_tokens_details.image_tokens.

object

Fine-grained classification and cache details of input tokens. Returned for multimodal input or when Session cache is enabled.

Show child attributes

integer

The number of text input tokens.

integer

The number of image input tokens.

integer

The number of cache-hit tokens.

integer

The number of tokens for which a new cache entry was created in this request.

object

Cache creation details.

Show child attributes

integer

The number of tokens created for the 5-minute ephemeral cache.

string

The cache type. Fixed as ephemeral.

object

Fine-grained classification of output tokens. Returned for multimodal input.

Show child attributes

integer

The number of reasoning process tokens.

integer

The number of text output tokens. Returned for multimodal input.

object

Built-in tool call statistics. Returned when built-in tools (such as web_search) are used, same as the top-level x_tools field.

Show child attributes

object

Web search call statistics.

Show child attributes

integer

The number of web search calls in this response.

object

Statistical information about tool usage. If built-in tools are used, this field includes the number of calls for each tool. Example: {"web_search": {"count": 1}}