Skip to main content

API Overview

This page lists the public service APIs for Tongyi DeepSearch. All APIs use the DashScope HTTP protocol.

API Authentication

Before you call an API, obtain an API key. During the invitational preview, only API keys from the default workspace in Alibaba Cloud Model Studio can call these APIs.

API Directory

API Name

API Overview

Generate Conversation

Use the agent_id and agent_version from Agent Application Management to support scenario-based conversations, research, and writing.

Upload File

Use dynamic file operations to get processed file information. Then inject file data into the Dynamic Document Parsing tool by setting the parameters.agent_options.sessions_files parameter in your agent application API call.

Manage Conversation Files

DeepSearch supports a session-based file directory tree. Update the tree using temporary file IDs and file or folder metadata. Delete files and get updated tree information. This feature applies only to legal case review scenarios.

Export Generated Report

Get generated report files in Markdown, HTML, or PDF format.

Connect Your Own Knowledge Base

Connect your own knowledge base. Follow this API specification to integrate it. This feature applies only to general scenarios.

Agent Development
Agent Context
Agent Governance & Evolution
Store
Application Marketplace