> For the complete documentation index, see [llms.txt](https://nsclouds.gitbook.io/aillm.nscloud.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://nsclouds.gitbook.io/aillm.nscloud.ai/conversation-apis/dashscope/responses.md).

# Responses

### 1. Overview

DashScope exposes Responses capabilities in this environment.

{% hint style="success" %}
This endpoint provides an OpenAI-compatible Responses path. Actual parameter support may vary by vendor and model.
{% endhint %}

**Supported models：**

* `qwen3.6-flash`
* `qwen3.6-plus`
* `qwen3.7-max`

### 2. API Details

## Create Response

> Provides an OpenAI-compatible Responses endpoint. Supported parameters and behavior may vary by model.

```json
{"openapi":"3.1.0","info":{"title":"NSCloud AI API Documentation","version":"1.11.0"},"tags":[{"name":"responses_dashscope","description":"DashScope's Responses API"}],"servers":[{"url":"https://aillm.nscloud.ai","description":"Global Server"}],"security":[{"APIKeyHeader":[]}],"components":{"securitySchemes":{"APIKeyHeader":{"type":"http","scheme":"bearer","description":"Authenticate using Bearer token format: 'Bearer YOUR_SECRET_TOKEN'"}},"schemas":{"CreateResponseRequest":{"type":"object","description":"Responses protocol request body.","properties":{"model":{"type":"string","description":"Model ID to invoke."},"input":{"description":"Input payload, either plain text or an array of structured items.","oneOf":[{"type":"string","description":"Plain text input."},{"type":"array","description":"Structured input array.","items":{"$ref":"#/components/schemas/ResponseInputItem"}}]},"stream":{"type":"boolean","description":"Whether to return the response as a stream.","default":false}},"required":["model","input"],"additionalProperties":true},"ResponseInputItem":{"type":"object","description":"Structured input item for the Responses protocol.","properties":{"type":{"type":"string","description":"Input item type, such as message."},"role":{"type":"string","description":"Role associated with the input item."},"content":{"description":"Input content, either plain text or structured parts.","oneOf":[{"type":"string","description":"Plain text input."},{"type":"array","description":"Structured content part array.","items":{"$ref":"#/components/schemas/ResponseInputContentPart"}}]}},"additionalProperties":true},"ResponseInputContentPart":{"description":"Responses input content part. Supported input types are input_text, input_image, and input_file.","oneOf":[{"$ref":"#/components/schemas/ResponseInputTextPart"},{"$ref":"#/components/schemas/ResponseInputImagePart"},{"$ref":"#/components/schemas/ResponseInputFilePart"}]},"ResponseInputTextPart":{"type":"object","description":"Text input content part for the Responses protocol.","properties":{"type":{"type":"string","description":"Input part type.","enum":["input_text"]},"text":{"type":"string","description":"Text input value."}},"required":["type","text"],"additionalProperties":true},"ResponseInputImagePart":{"type":"object","description":"Image input content part for the Responses protocol. Supports image_url or OpenAI-compatible file_id; image_url is recommended today. Add multiple input_image parts to send multiple images.","properties":{"type":{"type":"string","description":"Input part type.","enum":["input_image"]},"image_url":{"type":"string","description":"Publicly accessible image URL or image data URL. Common image formats are supported; for example, data:image/png;base64,..."},"file_id":{"type":"string","description":"OpenAI-compatible field. Previously uploaded image file ID from the Files API; this platform capability is under construction/adaptation, and actual availability depends on file hosting and model-side support."},"detail":{"type":"string","description":"Detail level for image understanding, when supported.","default":"auto","enum":["auto","low","high"]}},"required":["type"],"anyOf":[{"required":["image_url"]},{"required":["file_id"]}],"additionalProperties":true},"ResponseInputFilePart":{"type":"object","description":"File input content part for the Responses protocol. Supports file_url, file_data, and OpenAI-compatible file_id; file_url or file_data is recommended today. Common document and text formats are supported; PDF is only one example.","properties":{"type":{"type":"string","description":"Input part type.","enum":["input_file"]},"file_id":{"type":"string","description":"OpenAI-compatible field. Previously uploaded file ID from the Files API; this platform capability is under construction/adaptation, and actual availability depends on file hosting and model-side support."},"file_url":{"type":"string","description":"Publicly accessible file URL used by file input parts, recommended today. Common document and text formats are supported."},"filename":{"type":"string","description":"File name used together with file_data for inline file uploads."},"file_data":{"type":"string","description":"Data URL containing base64-encoded file content, recommended today; for example, data:application/pdf;base64,... or data:text/plain;base64,..."}},"required":["type"],"anyOf":[{"required":["file_id"]},{"required":["file_url"]},{"required":["filename","file_data"]}],"additionalProperties":true},"ResponseObject":{"type":"object","description":"Responses protocol success response.","properties":{"id":{"type":"string","description":"Unique response ID."},"object":{"type":"string","description":"Object type, usually response."},"model":{"type":"string","description":"Model ID actually used for the request."},"status":{"type":"string","description":"Response processing status, such as completed, failed, or incomplete."},"created_at":{"type":"integer","description":"Unix timestamp in seconds when the response was created."},"output_text":{"type":"string","description":"Convenience text output aggregated from output content, when provided."},"output":{"type":"array","description":"Generated output items. Vendors may include messages, tool calls, reasoning, or other structured records.","items":{"$ref":"#/components/schemas/ResponseOutputItem"}},"error":{"type":["object","null"],"description":"Error information when response generation fails.","additionalProperties":true},"incomplete_details":{"type":["object","null"],"description":"Details explaining why a response is incomplete.","additionalProperties":true},"usage":{"$ref":"#/components/schemas/Usage"}},"additionalProperties":true},"ResponseOutputItem":{"type":"object","description":"A single item in a Responses output array.","properties":{"id":{"type":"string","description":"Unique identifier for the output item."},"type":{"type":"string","description":"Output item type, such as message or tool_call."},"role":{"type":"string","description":"Role associated with the output item."},"status":{"type":"string","description":"Processing status for the output item, when present."},"content":{"type":"array","description":"Structured output content parts.","items":{"$ref":"#/components/schemas/ResponseContentPart"}}},"additionalProperties":true},"ResponseContentPart":{"type":"object","description":"Flexible output content part used inside Responses output items.","properties":{"type":{"type":"string","description":"Output part type, such as output_text or tool_result."},"text":{"type":"string","description":"Text value carried by the part."},"annotations":{"type":"array","description":"Optional annotations attached to the content part.","items":{"type":"object","additionalProperties":true}}},"additionalProperties":true},"Usage":{"type":"object","description":"Token usage summary.","properties":{"prompt_tokens":{"type":"integer","description":"Number of input tokens consumed."},"completion_tokens":{"type":"integer","description":"Number of output tokens consumed."},"total_tokens":{"type":"integer","description":"Total number of tokens consumed."},"input_tokens":{"type":"integer","description":"Number of input tokens consumed for protocols that expose this field."},"output_tokens":{"type":"integer","description":"Number of output tokens consumed for protocols that expose this field."},"completion_tokens_details":{"type":"object","description":"Optional breakdown of completion token usage.","properties":{"reasoning_tokens":{"type":"integer","description":"Tokens consumed by reasoning or chain-of-thought style generation."}},"additionalProperties":true},"input_tokens_details":{"type":"object","description":"Optional breakdown of input token usage.","properties":{"text_tokens":{"type":"integer","description":"Input tokens attributed to text."},"image_tokens":{"type":"integer","description":"Input tokens attributed to images."}},"additionalProperties":true}}},"ErrorResponse":{"type":"object","description":"Error response payload.","properties":{"error":{"$ref":"#/components/schemas/ErrorDetail"}}},"ErrorDetail":{"type":"object","description":"Error detail object.","properties":{"message":{"type":"string","description":"Human-readable error message."},"type":{"type":"string","description":"Error type."},"param":{"description":"Parameter associated with the error, if any.","type":["string","null"]},"code":{"description":"Machine-readable error code, if any.","type":["string","null"]}}}},"responses":{"ErrorResponse":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/v1/responses":{"post":{"tags":["responses_dashscope"],"summary":"Create Response","description":"Provides an OpenAI-compatible Responses endpoint. Supported parameters and behavior may vary by model.","operationId":"createResponse_dashscope","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponseRequest"}}}},"responses":{"200":{"description":"Success Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseObject"}},"text/event-stream":{"schema":{"type":"string","description":"Responses streaming returns Server-Sent Events with typed semantic event payloads."}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"$ref":"#/components/responses/ErrorResponse"},"429":{"$ref":"#/components/responses/ErrorResponse"}}}}}}
```