Alibaba AI Docs

Appearance

API Reference: Applications ​

Browse documentation for api reference: applications. Pages organized by topic:

Application Calling ​

  • Get an app ID and a workspace ID — When you make API calls to applications in Alibaba Cloud Model Studio, such as an Agent or a Workflow, you must provide credentials to speci
  • Application DashScope API reference — Input and output parameters for calling Alibaba Cloud Model Studio applications (Agent, Workflow) using the DashScope API, with invocation e

Application Components ​

  • API overview — API standard and pre-built SDKs in multi-languageThe OpenAPI specification of this product (bailian/2023-12-29) follows the ROA standard
  • Endpoints — Asia PacificRegion nameRegion IDPublic endpointVPC endpointChina (Beijing)cn-beijingbailian
  • RAM authorization — Resource Access Management (RAM) is a service provided by Alibaba Cloud to manage user identities and resource access permissions
  • API change records — Change time: 2026-03-30Changeset Release Notes:OpenAPI nameSummary of changesOperationCreateIndexThe request parameters of the API has chang

Assistant API (Deprecated) ​

  • Assistants (Deprecated) — The assistant API simplifies building assistants, which are a type of Large Language Model (LLM) application
  • Threads (Deprecated) — This topic describes the Thread class in the assistant API, including how to create, retrieve, modify, and delete threads
  • Messages (Deprecated) — This topic describes how to use the Message class in the assistant API to create, list, retrieve, and modify messages
  • Runs (Deprecated) — A run represents an execution of an agent in a thread
  • Run steps (Deprecated) — Run steps describe the actions that an agent takes during a run, including model and tool calls
  • Call examples (Deprecated) — This document provides examples that demonstrate how to use agents

Data Connection (Formerly Application Data) ​

  • AddCategory — Creates a category in a specified workspace to classify and manage files
  • ListCategory — Understand how ListCategory enables workspace category traversal in Alibaba Cloud Model Studio via paginated queries — essential for organiz
  • DeleteCategory — Clean up unused Model Studio categories by calling the idempotent DeleteCategory API
  • ApplyFileUploadLease — Applies for a document upload lease to upload a document
  • AddFile — Imports an unstructured document stored in the temporary storage space to Data Management
  • AddFilesFromAuthorizedOss — Call the AddFilesFromAuthorizedOss API to programmatically import unstructured documents from an authorized OSS bucket into your Model Stu
  • ListFile — Paginate through large document sets in a knowledge base category using the ListFile API with CategoryId, MaxResults, and NextToken — preven
  • DescribeFile — Obtains the basic information of a document, including the document name, type, and status
  • UpdateFileTag — Updates the tags for a specified file
  • BatchUpdateFileTag — This operation updates document tags in a data connection in batches
  • DeleteFile — Permanently delete a specified file from application data
  • GetParseSettings — Queries the data parsing settings in a specified category
  • GetAvailableParserTypes — Lists all supported parser types based on the input file type (file extension)
  • ChangeParseSetting — Configures the parsing method for a specific file type
  • AddTable — Adds a table for a tabular data connector
  • UpdateTableFromAuthorizedOss — Update a table in an Alibaba Cloud Model Studio data connector using a file from an authorized OSS bucket

Knowledge Base ​

  • CreateIndex — Use this API to create two types of knowledge bases: unstructured knowledge bases for documents, audio, or video, and structured knowledge b
  • GetIndexJobStatus — Queries the current status of a specified knowledge base creation or add document job
  • SubmitIndexJob — Submits a specified CreateIndex job to complete knowledge base creation
  • SubmitIndexAddDocumentsJob — Adds parsed documents to an unstructured knowledge base
  • Retrieve — Queries information from a specified knowledge base
  • ListIndexDocuments — Queries the details of one or more documents in a specified knowledge base
  • ListIndexFileDetails — Retrieves the details of one or more documents in a specified knowledge base
  • DeleteIndexDocument — Deletes one or more documents from a specified unstructured knowledge base permanently
  • ListIndices — Lists the details about the next or multiple knowledge bases in a specified workspace
  • DeleteIndex — Deletes a specified knowledge base permanently
  • ListChunks — For unstructured knowledge base, obtains the details of all chunks of a specified document; for structured knowledge base, obtains the detai
  • UpdateChunk — Modifies the content and title of a specified text chunk in the knowledge base, and sets whether the chunk participates in knowledge base re
  • DeleteChunk — Deletes a specified text chunk from a knowledge base

More ​

  • Service-linked roles — Explore the service-linked roles used by Model Studio to access resources in Function Compute and Object Storage Service, and learn how to m
  • Generate a temporary API key — Exposing your master DASHSCOPE_API_KEY to third-party apps is a security risk
  • Knowledge base SearchFilters — The Retrieve API returns text segments from a knowledge base based on semantic similarity

Others ​

  • ApplyTempStorageLease — This interface is intended for pro-code deployment only; other scenarios are currently not supported

Prompt Engineering ​

Mirror of Alibaba Cloud Model Studio docs for reference and RAG. Not affiliated with Alibaba Cloud.

Source: alibabacloud.com/help/en/model-studio