API overview

Updated at:
Copy as MD

API standards and multilingual preset SDKs

The OpenAPI of this product (AgentCore/2026-08-04) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Workspace

API

Title

Description

Lifecycle management Lifecycle management
CreateWorkspace Create a workspace Creates an AgentCore workspace as a resource scope for organizing agents, models, MCP services, and collaboration configurations.
ListWorkspaces List workspaces Performs a paged query of workspaces under the current tenant. By default, the list does not return soft-deleted records with the Deleted status, and the server performs stable sorting of the results by creation order during paging.
GetWorkspace Query a workspace Queries the details of a workspace by workspace ID, including the lifecycle status, CMS workspace, AI Registry namespace, and current network policies.
UpdateWorkspace Update a workspace Updates the name or network configuration of a workspace. Only workspaces in the Initialized state can be updated. The Status, TenantId, and RegionId fields are maintained by the server and cannot be modified through this operation.
DeleteWorkspace Delete a workspace Deletes a workspace that is no longer in use and ends the management lifecycle of the workspace.
Collaboration components Collaboration components
GetWorkspacePlugin Query workspace components Queries the activation status and configuration of a specified component in a workspace. The collaboration value corresponds to the Collaboration component displayed in the console.
InstallWorkspacePlugin Enable workspace component Enables a component for a workspace, which corresponds to the operation of enabling the collaboration component in the console. After the component is enabled, you can query its status and current configurations.
Storage mount authorization (OSS/NAS) Storage mount authorization (OSS/NAS)
VerifyWorkspaceOssMountRamAuthorization Verify workspace OSS mount RAM authorization Verifies the OSS mount authorization for a workspace, or checks and updates the authorization status of the default OSS storage for the workspace.
GetWorkspaceAgenticFsMountRamAuthorizeUrl Retrieve NAS mount authorization link Retrieves the RAM page URL to authorize the workspace resource role to access a specified AgenticFS access point before configuring NAS storage mounting for an agent.
VerifyWorkspaceAgenticFsMountRamAuthorization Query NAS mount authorization status Queries whether the workspace resource role has been granted access to the target NAS (AgenticFS) access point for subsequent Agent mount configurations.

Agent management

API

Title

Description

Custom agents (code packages / images) Custom agents (code packages / images)
Lifecycle management Lifecycle management
CreateCustomAgent Create a custom code or image agent Creates a custom code or image agent in a specified workspace. Supports code package, ACR image, and custom image deployments, and executes the deployment asynchronously.
ListCustomAgents List custom code or image agents Performs a paging query for the identifiers, deployment methods, and status summaries of custom code or image agents in a workspace.
GetCustomAgent Query custom code or image agent details Queries the latest deployment configuration, version processing results, code package or image information, and running instance status of a custom code or image agent.
UpdateCustomAgent Update a custom code or image agent Updates the configuration of a custom code or image agent in a specified workspace and executes the update asynchronously. Omitted top-level fields retain their original configurations. You can call the GetCustomAgent operation to query the update result.
DeleteCustomAgent Delete a custom code or image agent Deletes a custom code or image agent in a specified workspace and asynchronously cleans up its associated platform resources.
Code packages and deployment preparation Code packages and deployment preparation
ListAgentCodeRuntimes Query agent code runtime environments Queries the identity, name, and architecture of language runtime environments currently available for code package deployment.
GetAgentCodePackageUploadUrl Get upload URL for agent code package Generates a time-limited upload URL for a local code package and returns the upload method, request headers, and the sourceUri for subsequent deployment.
GetAgentCodePackageOssRamAuthorizeUrl Obtain the OSS authorization URL for agent code packages Generates a RAM authorization URL for a specified code package source bucket for the workspace resource role.
VerifyAgentCodePackageOssRamAuthorization Check OSS authorization status for agent code package Queries the binding status of the authorization policy for the code package source bucket to the current workspace resource role.
ValidateAgentCodePackageFromOss Validate the source of an agent OSS code package Validates the read permissions of the workspace role on a specified OSS code package object, and returns the source URI and package information.
GetAgentCodePackageDownloadUrl Retrieve agent code package download URL Retrieves the time-limited read-only download URL for the currently saved fixed code package of a custom code or image agent.
Image authorization and preparation progress Image authorization and preparation progress
GetWorkspaceAcrRamAuthorizeUrl Get ACR authorization link Generates a RAM authorization link for a workspace resource role to pull images from a specified ACR Enterprise Edition repository.
VerifyWorkspaceAcrRamAuthorization Verify ACR authorization results Queries the authorization status of a workspace resource role for a specified ACR Enterprise Edition repository.
FindCustomAgentImagePreparation Query custom image preparation progress by client token Retrieves a custom image preparation task by using a submitted client token and queries the current progress.
GetCustomAgentImagePreparation Query custom image preparation progress Queries the preparation and deployment progress of the current submission for a custom image by preparation task ID.
Image cache Image cache
CreateImageCache Create an image cache Creates or reuses an image cache for ACR Enterprise Edition images in a workspace, and returns the cache status upon acceptance.
ListImageCaches List image caches Performs a paged query on image caches in a workspace, and supports paging and filtering by image source and cache status.
GetImageCache Retrieve image cache details Queries the status, digest, size, and deletion conditions of an image cache in a specified workspace.
RetryImageCache Retry image cache Resubmits the creation request for an ACR image cache in a specified workspace.
DeleteImageCache Delete image cache Deletes the image cache association in a workspace and checks agent references and instance usage before submission.
Managed harness agents Managed harness agents
Lifecycle management Lifecycle management
CreateManagedAgent Create a managed harness agent Creates a managed Harness agent in a specified workspace, configures the harness, model, skills, and runtime resources, and deploys it asynchronously.
ListManagedAgents List managed harness agents Performs a paging query to retrieve the identity, harness, configuration version, and status summary of managed Harness agents in a workspace.
GetManagedAgent Retrieve a managed harness agent Queries the latest configuration, Harness, skill versions, configuration processing status, and running instance statistics of a managed Harness agent.
UpdateManagedAgent Update a managed harness agent Updates the model, instructions, skills, and runtime configuration of a managed Harness agent and executes the update asynchronously. Omitted top-level fields retain their original configuration.
DeleteManagedAgent Delete a managed harness agent Deletes a managed Harness agent in a specified workspace and asynchronously cleans up its platform-associated resources.
Qoder CLI connector Qoder CLI connector
ListConnectors List connectors Queries the list of connectors supported by a specified workspace, along with their status, number of bound agents, and configurations. The current version returns the QoderCLI connector.
UpdateConnector Update a connector Updates the API key or service account key collection for an enabled QoderCLI connector. When serviceAccountKeys is submitted, the service treats it as the updated complete key collection to perform additions, renames, rotations, and deletions.
VerifyConnector Validate connector credentials Validates whether one or more Qoder service account keys are available at a specified site. This operation does not save the keys or modify the connector status.
EnableConnector Enable connector Enables the QoderCLI connector in a specified workspace. The request must provide a site, an API key, and at least one service account key. The service verifies all account keys before saving the configuration.
DisableConnector Disable connector Disables the QoderCLI connector in a specified workspace. The connector can be disabled only if no agents are using it. After the connector is disabled, the connector and its service account key configuration are removed.
ListConnectorModels List connector models Queries the official and enterprise models available for the enabled QoderCLI connector. The service retrieves models in real time by using the saved API key and organization ID, and deduplicates them by model ID.
Onboarded agents Onboarded agents
Lifecycle management Lifecycle management
CreateExternalAgent Create a managed agent Creates an agent that runs in an external environment, saves the configurations for the platform model, instructions, tools, and skills, and asynchronously processes the onboarding configuration.
ListExternalAgents List managed agents Performs a paging query for the identity, configuration version, and status summary of managed agents in a workspace.
GetExternalAgent Query managed agent Queries the configuration, model source, version processing status, and external runtime status of a managed agent.
UpdateExternalAgent Update a managed agent Updates the model source, instructions, tools, and skills of a managed agent, and processes the configuration asynchronously.
DeleteExternalAgent Delete a managed agent Deletes a managed agent from a specified workspace and asynchronously cleans up its associated platform resources.
Access methods and tokens Access methods and tokens
GetExternalAgentBootstrapOptions Query access networks for a managed agent Queries the available internal and public network access options for a managed agent.
CreateExternalAgentBootstrapToken Create a bootstrap token for a managed agent Issues an access token for a specified network to an active managed agent and returns the CMS configuration.
Running instances and sessions Running instances and sessions
ListSandboxes List sandboxes Performs a paging query on the running instances of an agent and supports filtering by sandbox ID and current valid session ID fragments.
ListSandboxSessions List active sandbox sessions Performs a paging query to retrieve the current active sessions and their sources in a specified agent instance.
RebuildSandbox Rebuild sandbox Submits a request to rebuild a single sandbox image for a specified managed agent. Existing sessions may be interrupted. An HTTP 200 response only indicates that the request is accepted. Use the returned operationId to call GetSandboxRebuildOperation to query the overall result. Only a SUCCEEDED status indicates that the rebuild is complete. Do not automatically resubmit the rebuild request if the query times out, returns UNKNOWN, or the result is unclear.
GetSandboxRebuildOperation Query sandbox rebuild task Queries the overall result of a specified sandbox rebuild task. Always use the initial operationId returned by RebuildSandbox without tracking the rebuild task and subsequent creation tasks separately. Only the SUCCEEDED status indicates completion. Do not treat UNKNOWN, missing status, or query exceptions as success, and do not automatically resubmit the rebuild.
IM channel integration IM channel integration
CreateAgentIMChannel Create an agent IM channel Creates an instant messaging (IM) channel for a specified agent and binds a publicly accessible ServiceEndpoint.
ListAgentIMChannels List IM channels of an agent Queries the IM channels of a specified agent.
GetAgentIMChannel Query agent IM channel Queries the details of a specified agent IM channel.
UpdateAgentIMChannel Update agent IM channel Updates the ServiceEndpoint, enabling status, or channel behavior configuration bound to an IM channel. At least one updatable field must be provided.
UpdateAgentIMChannelCredential Update agent IM channel credentials Updates all channel credentials for a specified IM channel. Secrets are not returned in the response.
DeleteAgentIMChannel Delete agent IM channel Deletes the IM channel of a specified agent.

Service endpoints and access keys

API

Title

Description

ListServiceEndpoints List service endpoints Performs a paging query of service endpoints in a specified workspace and supports filtering by target type, agent, collaboration component, and status.
GetServiceEndpoint Query a service endpoint Queries the details of a specified service endpoint, including the target route, access address, authentication configuration, and current status.
GetServiceEndpointApiKey Query service endpoint API key Queries the currently effective API key and its invocation method for a service endpoint in a specified workspace.

MCP tool services

API

Title

Description

Service management and tool queries Service management and tool queries
GetMcpCodePackageUploadUrl Get MCP code package upload URL Returns a time-limited presigned upload URL and a temporary code package token. After the upload is complete, the token can be directly used to create or update a code deployment.
CreateMcp Create an MCP service Creates an MCP service in a specified workspace. The creation process is asynchronous. You can check the returned status or call a query operation to verify whether the service is ready.
ListMcps List MCP services Performs a paging query for the MCP services and their configurations and statuses in a specified workspace.
GetMcp Query MCP service details Queries the details of a specified MCP service, such as the address, type, status, authentication configuration, and protocol.
UpdateMcp Update an MCP service Updates the address, description, authentication, or Swagger configuration of a specified MCP service. The MCP type and protocol cannot be modified after creation. The update process is asynchronous.
DeleteMcp Delete an MCP service Deletes a specified MCP service. The deletion is an asynchronous process. After the process is complete, the MCP service is no longer returned.
ListMcpTools List MCP tools Queries the list of tools exposed by a specified MCP service and their input and output schemas.
MCP marketplace and templates MCP marketplace and templates
ListMcpMarketItems List MCP marketplace templates Queries MCP marketplace templates.
GetMcpMarketItem Query MCP marketplace template details Queries the details of an MCP marketplace template.
InstallMcpMarketItem Install an MCP marketplace template Installs an MCP marketplace template.
UpdateMcpTemplateConfig Update configuration parameters for a template-managed MCP Updates the parameters of an MCP service based on a template.
ConvertMcpToFreeEdit Convert an MCP service to free edit mode Converts an MCP service to free edit mode.

Model management

API

Title

Description

Preset vendors and models Preset vendors and models
ListPredefinedModelProviders Query predefined model provider catalog Queries the providers supported by the AgentCore built-in model catalog and their default service configurations.
ListPredefinedModels Query the predefined model catalog for a provider Queries the models and their capabilities in the built-in model catalog of AgentCore for a specified provider.
Model connections Model connections
CreateModelConnection Create a model connection Creates a model connection in a specified workspace and configures the upstream model service endpoint, invoke protocol, and access credentials for model creation.
ListModelConnections List model connections Queries model connections in a specified workspace by using paging, and supports filtering by name, provider type, and invocation protocol.
GetModelConnection Get model connection Queries the detailed configuration, credential configuration status, publish status, and region of a specified model connection.
UpdateModelConnection Update a model connection Updates the mutable configurations of a specified model connection and resubmits the publishing task. The invocation protocol cannot be modified after creation.
DeleteModelConnection Delete a model connection Submits an asynchronous deletion task for a specified model connection. The connection cannot be deleted if it has associated models or runtime references.
Model configuration and debugging Model configuration and debugging
CreateModel Create a model Creates a model configuration under a model connection in a specified workspace for model creation.
ListModels List models Performs a paging query for models in a specified workspace and supports filtering by model connection and model name.
GetModel Query a model Queries the detailed configuration and region of a model in a specified workspace.
UpdateModel Update a model Updates the description, context token limit, maximum output token count, or capability configurations of a specified model.
DebugModel Test model Invokes a specified model through a published model connection to verify whether the model invocation pipeline is available.
DeleteModel Delete a model Deletes a model in a specified workspace. Models that are in use cannot be deleted.
BatchDeleteModels Delete models in batches Deletes models from a specified workspace in batches. If any model is in use, the entire batch request fails.

Identity and access control

API

Title

Description

Application users Application users
CreateUser Create a user Creates a user in a specified workspace. The username must be unique within the workspace, can contain only lowercase letters, digits, and hyphens, and cannot be a reserved name such as manager, admin, or any name starting with worker-. If the password is not specified, the server generates an initial password and returns it in the initialPassword field of the response.
ListUsers List users Performs a paged query for users in a specified workspace. You can use nameLike to filter users by fuzzy match on the username, maxResults to specify the maximum number of records per page, and nextToken to retrieve the next page during paging. If maxResults is not specified, the server returns 10 records by default.
GetUser Get user Queries the details of a specific user in a specified workspace. Returns an error if the user does not exist.
UpdateUser Update a user Updates the display name, email address, or note of a specified user. You must specify at least one of the displayName, email, and note parameters. Unspecified attributes remain unchanged. The username cannot be modified after creation.
ResetUserPassword Reset user password Resets the logon password of a specified user. Specify the user by using agentCoreUserId or username. At least one of the two parameters is required. This operation only supports users who use local password authentication in the workspace. If the password parameter is not specified, the server generates a random password and returns it in the response.
DeleteUser Delete a user Deletes a user from a specified workspace. A user cannot be deleted if they are still a member of any team. Remove the user from the team first.
Collaboration teams and members Collaboration teams and members
CreateTeam Create a team Creates a team in a specified workspace and configures user members and agent members at the same time. The user members must include exactly one member with the ADMIN role, and agent members can only have the LEADER or WORKER role.
ListTeams List teams Queries teams in a specified workspace with paging. You can use nameLike to filter teams by fuzzy match on the team name, maxResults to specify the maximum number of records per page, and nextToken to obtain the next page. If maxResults is not specified, the server returns 10 records by default. The member information in the list includes only the member identifier, name, and team role.
GetTeam Query a team Queries the details of a specified team. The response also returns the complete attributes and team roles of each user and agent member in the team.
UpdateTeam Update a team Updates the description and members of a specified team. When users or agents are provided, the corresponding member list is replaced based on full overwrite semantics. Member lists that are not provided remain unchanged. The team name cannot be modified after creation.
ListAgentTeams Query agent teams Queries the teams to which specified agents belong. Specify the agent IDs to query by using agentIds. The operation returns the membership information of each agent in its teams, including the team ID, team name, and the role of the agent in the team.
DeleteTeam Delete a team Deletes a team in a specified workspace. Deleting a team does not delete the users and agents within it, but only dissociates the members.
External identity sources External identity sources
Bindings and configuration Bindings and configuration
CreateIdentityProvider Bind an external identity provider Integrates an external identity provider such as DingTalk, Lark, or a custom identity source into a workspace for enterprise account logon and user synchronization.
ListIdentityProviders List external identity providers Queries the summary of existing identity provider bindings for a workspace, including CustomSSO. Returns local binding information without querying the actual upstream SAML or SCIM configurations.
GetIdentityProvider Query external identity provider Queries the binding and expected configuration of a specified identity provider. When SAML is configured for CustomSSO, this operation reads back the actual upstream SSO configuration. The SCIM status is queried through a separate API operation.
UpdateIdentityProvider Update external identity provider Modifies the configuration of a bound identity provider in a specified workspace. DingTalk and Feishu support login switches, address book synchronization switches, application configurations, and synchronization scopes. CustomSSO supports SAML or OIDC login configurations and login switches. SCIM user synchronization is configured independently. Updates take effect asynchronously. You can query the status by calling GetIdentityProvider.
DeleteIdentityProvider Disconnect an external identity provider Disconnects the identity source integration for a workspace. For CustomSSO, this operation clears the shared user pool and related SAML and SCIM resources. To disable only logon or synchronization, use the corresponding API operations.
Organization scope and synchronization tasks Organization scope and synchronization tasks
GetIdentityProviderSyncScope Query the synchronization scope of an identity provider Queries the synchronization scope of an identity provider.
ListIdentityProviderDepartments List identity provider departments Performs a paged query on the departments of an identity provider by using paging.
CreateIdentityProviderSyncJob Create an identity provider synchronization task Initiates a manual synchronization of an identity provider.
GetIdentityProviderSyncJob Query identity provider synchronization task Queries an identity provider synchronization task.
SAML integration information SAML integration information
GetIdentityProviderServiceProvider Query SAML service provider information Queries the SAML service provider (SP) information for CustomSSO, including the Entity ID, ACS URL, and SP metadata XML, to help users configure an external IdP.
SCIM integration configuration and credentials SCIM integration configuration and credentials
PrepareIdentityProviderSCIM Prepare SCIM receiving configuration and credentials Prepares the SCIM receiving configuration and returns the provisioning URL and credential summary. Issues a token if no available credentials exist and returns the plaintext only in the current response without automatically enabling user synchronization in AgentCore.
GetIdentityProviderSCIM Query SCIM configuration and independent operation status Queries the actual SCIM receiving configuration, the expected AgentCore synchronization switch, and the status of the most recent independent SCIM task. SAML configuration is not required in advance.
UpdateIdentityProviderSCIM Confirm or disable SCIM synchronization Enables or disables SCIM-based user synchronization independently. When enabled, an initial full import is executed asynchronously. You can query the result by calling GetIdentityProviderSCIM. The SAML logon configuration is retained.
CreateIdentityProviderSCIMCredential Create a SCIM credential Issues a SCIM credential explicitly and returns the plaintext token only in the current response. A maximum of two credentials are allowed per pool. This operation does not automatically revoke old credentials or enable AgentCore user synchronization.
ListIdentityProviderSCIMCredentials List SCIM credentials Queries the complete summary list of up to two SCIM credentials in a shared user pool. Plaintext tokens are not returned, and pagination is not supported.
DeleteIdentityProviderSCIMCredential Delete a SCIM credential Revokes a specified SCIM credential. This operation does not trigger automatic creation of a new token, modify the access configuration synchronization switch, or disable SAML logon.
Outbound credentials Outbound credentials
CreateCredential Create a credential Creates an apiKey or mcpHeader credential in a workspace for agents or MCP to access external services. The credential content is submitted as a JSON string, and masked results are returned when queried.
ListCredentials List credentials Queries credentials in a specified workspace with paging. Filters credentials by type using credentialType, performs fuzzy matching on credential names using nameLike, specifies the maximum number of records per page using maxResults, and retrieves the next page using nextToken. If maxResults is not specified, the server returns 10 records by default.
GetCredential Query a credential Queries the details of a specified credential and returns a list of agents bound to the credential. The credential content is returned in a masked format.
UpdateCredential Update a credential Updates the content, description, or MCP header application scope of a specified credential. Unspecified configurations retain their original values. The credential name and type cannot be modified.
DeleteCredential Delete a credential Deletes a specified credential in a workspace and the ciphertext hosted in the credential service. After the deletion, agents bound to the credential can no longer obtain the credential content.
Resource access rules Resource access rules
CreatePermissionRules Create permission rules Creates permission rules.
ListPermissionRules List permission rules Queries permission rules.
DeletePermissionRule Delete a permission rule Deletes a permission rule.
Connected applications Connected applications
GetAccessApplication Retrieve access application details Queries the access application.
UpdateAccessApplication Update an access application Updates an access application.
DeleteAccessApplication Delete an access application Deletes an access application.

Memory management

API

Title

Description

Memory stores Memory stores
CreateMemoryStore Create a memory store Creates a long-term memory store in a specified workspace.
ListMemoryStores List memoryStores Queries MemoryStores in a specified workspace by using paging.
GetMemoryStore Query memoryStore Queries the public information and current status of a MemoryStore in a specified workspace.
UpdateMemoryStore Update a memory store Updates a memory store.
DeleteMemoryStore Delete a memoryStore Asynchronously deletes a MemoryStore and all long-term memory within it.
Memory read/write and retrieval Memory read/write and retrieval
AddMemories Write memories Extracts memories from text or messages, or directly writes organized memories. When the extract parameter is omitted or set to true, either the text parameter or non-empty messages must be provided. When the extract parameter is set to false, the memories parameter is used. When the sync parameter is omitted or set to true, the operation waits for processing to complete and returns memory references. An empty array is returned if no new memories are generated. When the sync parameter is set to false, a task ID is returned, and you can use GetMemoryTask to query the result. Direct writes do not create extraction tasks.
ListMemories List memories Performs a paged query on memories in a memory store. Supports paging and filtering by associate scope, content type, source, validity status, and update time. Unspecified scope dimensions are excluded from filtering. If valid is omitted, only valid memories are returned. If valid is set to false, revoked memories are returned.
GetMemory Query memory details Queries the content, associated scope, metadata, source, type, and validity status based on the memory ID.
UpdateMemory Update a memory Updates the content or metadata of a specified memory. At least one field must be provided for the update, and unprovided fields retain their original values. The metadata is fully replaced. Pass an empty object to clear the metadata.
SearchMemories Retrieve memories Retrieves relevant memories based on the query text. Supports filtering by association scope, type, and metadata, and sets result thresholds through similarity and relevance scores. If topK is omitted or set to 0, the default value 10 is used, with a maximum of 200.
DeleteMemory Delete long-term memory Deletes a long-term memory based on the memory ID.
Extraction task queries Extraction task queries
GetMemoryTask Query memory task details Queries the status, input, execute results, and error message of a memory extraction node. A successful node may not generate new memories. If a fault occurs, check the error field for the cause.
Session and message queries Session and message queries
ListMemorySessions List memory sessions Performs a paging query of sessions in a memory store. You can filter the sessions by user, team, or agent. Unspecified dimensions are not used for filtering.
ListMemorySessionMessages List memory session messages Performs a paging query for raw messages by exact scope. SessionId is required, and at least one of UserId or AgentId must be provided.

Skills

API

Title

Description

Queries and reference relationships Queries and reference relationships
ListSkills List skills Performs a paged query for skills in a specified workspace and returns the basic information, version status, and paging information of the skills.
GetSkillDetail Query skill details Queries the basic information, version status, tags, visibility scope, and version list of a specified skill.
GetSkillVersionDetail Query skill version details Queries the complete details of a specified skill version, including version metadata, skill content, and associated resources.
ListSkillReferences Query skill reference data Queries the reference relationships of a skill.
Import and export Import and export
GetSkillImportFileUrl Retrieve skill import URL Retrieves the OSS presigned upload URL and object name required to import a skill ZIP package. After the upload is complete, call the skill OSS upload API to complete the import.
PrecheckSkillUploadViaOss Precheck skill upload Parses and checks one or more skill ZIP packages uploaded to OSS, and returns the names, versions, and conflict check results.
UploadSkillViaOss Upload a skill from OSS Imports a skill into the current workspace by retrieving and parsing an uploaded skill ZIP package from OSS.
BatchUploadSkillsViaOss Batch upload skills Uploads multiple skill ZIP packages through OSS and returns the processing result for each skill.
DownloadSkillVersionViaOss Download skill version Retrieves the OSS pre-signed download URL for a specified skill version to download the corresponding skill ZIP package.
Drafts, versions, and releases Drafts, versions, and releases
CreateSkillDraft Create a skill draft Creates a skill in a specified workspace and generates an editable draft version. You can derive the draft from an existing version, or specify a target version and a commit message.
DeleteSkillDraft Delete skill draft Deletes the draft version of the specified skill that is currently being edited.
SubmitSkillVersion Submit a skill version for review Submits a specified draft version of a skill for review.
PublishSkillVersion Publish skill version Publishes a specified skill version and sets its status to published.
ForcePublishSkillVersion Force publish a skill version Forcibly publishes the specified skill version by bypassing the standard review process.
RedraftSkillVersion Re-edit skill version Reverts a specified skill version to an editable draft for further modification.
OnlineSkill Publish a skill Sets the specified skill version as the online version.
OfflineSkill Take a skill offline Takes the online version of a specified skill offline so that it is no longer used as the online version.
Tags, visibility, and deletion Tags, visibility, and deletion
UpdateSkillLabels Update skill version labels Updates the version labels and their mappings for a specified skill.
UpdateSkillBizTags Update skill business tags Updates the business tags of a specified skill. Other attributes that are not specified remain unchanged.
UpdateSkillScope Update skill visibility scope Updates the visibility scope of a specified skill.
DeleteSkill Delete a skill Deletes a skill and its related version data from the specified workspace. This operation is irreversible.

Agent templates (AgentSpec)

API

Title

Description

Template management Template management
CreateAgentSpec Create an agentSpec Creates an AgentSpec in a specified workspace and generates the first draft version. Returns a resource conflict error if an AgentSpec with the same name already exists.
ListAgentSpecs List agentSpecs Performs a paging query for AgentSpecs in a specified workspace, and supports name search, sorting, and filtering by owner, visibility scope, and business labels.
GetAgentSpec Query agentSpec details Queries the governance details of a specified AgentSpec, including basic information, governance pointers, and summaries of all versions.
GetAgentSpecLatest Query the latest version of an agentSpec Queries the full content of the latest version of a specified AgentSpec for editing or viewing the latest version.
UpdateAgentSpec Update agentSpec metadata Updates the business tags, version tags, and visibility scope of a specified AgentSpec. Fields not passed remain unchanged.
DeleteAgentSpec Delete an agentSpec Deletes the specified AgentSpec and all its versions and metadata. The deletion operation is irreversible.
Version management Version management
CreateAgentSpecVersion Create an agentSpec draft version Creates a new draft version for an existing AgentSpec. The AgentSpec must exist and cannot have a draft currently being edited.
GetAgentSpecVersion Query a specified agentSpec version Queries the complete content of a specified AgentSpec version, including the manifest content, resource files, and metadata.
SubmitAgentSpecVersion Submit an agentSpec version for review Submits a specified draft version of an AgentSpec for review. If no release pipeline is configured, the version is directly published online.
DeleteAgentSpecVersion Delete agentSpec draft version Deletes the draft version of the specified AgentSpec that is currently being edited and clears the draft version pointer.
Import and export Import and export
GetAgentSpecImportFileUrl Retrieve the agentSpec import URL Retrieves the OSS presigned upload URL and object name required to import an AgentSpec ZIP package. After the upload is complete, you can call the AgentSpec OSS upload API operation to complete the import.
UploadAgentSpecViaOss Upload agentSpec via OSS Retrieves an uploaded AgentSpec ZIP package from OSS, parses it, and imports the AgentSpec into the current workspace.
DownloadAgentSpecViaOss Download agentSpec Retrieves the OSS presigned download URL for a specified AgentSpec to download the AgentSpec ZIP package.

Others

API

Title

Description

CreateAgentVersion Save agent version Saves an agent version.
DeleteAgentVersion Delete an agent version Deletes an agent version.
GetAgentVersion Retrieve agent version details Queries the details of an agent version.
ListAgentVersions List agent versions Queries the list of agent versions.

Others

API

Title

Description

CreateEvents Write session events Writes messages, summaries, or session fork events in batches. Each batch supports 1 to 100 events and returns the write results one by one in the same order as the request. A successful request does not indicate that every event is written successfully, nor does it indicate that memory extraction is complete. The session title and metadata are set only when the session is created for the first time. Subsequent writes do not update existing session information.
CreateMemoryRule Create a memory rule Creates an extraction rule for a memory store, specifying the rule name, enabling status, and extraction strategy. After the rule is enabled, extraction is triggered when 8 pending extraction events accumulate in a session or when no new pending extraction events are added for 60 consecutive seconds.
CreateServiceEndpoint Create a service endpoint Creates a service endpoint.
DeleteEvents Delete session events Deletes events written by a specified session in batches, supporting 1 to 100 event IDs per batch. Returns the deletion results for each event. Events inherited from a parent session cannot be deleted in a child session. Deleting events does not delete extracted memories.
DeleteMemoryRule Delete a memory rule Deletes a specified memory rule. The system no longer uses this rule to extract subsequent new content. Existing memories are retained. Deleting the same rule multiple times returns a success response.
DeleteMemorySession Delete a memory session Deletes a session and its queryable event history within a specified association scope. If you write to the same association scope and sessionId again, a new session is created, and the history of the deleted session cannot be queried. Extracted memories are retained after the session is deleted.
GetMemoryRule Query memory rule details Queries the configuration and task statistics of a specified memory rule, including the number of tasks and the latest execution status.
ListEvents Query session events Performs a paged query on the events of a specified session in chronological order from oldest to newest, including the parent session history referenced when a session branch is created. The sessionId parameter is required, and other scope dimensions must match those used when the events were written. If you write or delete events during paging, the results of subsequent pages may be affected.
ListMemoryRules List memory rules Queries extraction rules in a memory store by using paging. Supports filtering by name and enabled status, and returns rule configurations.
ListMemoryTasks List memory extraction tasks Performs a paging query on the memory extraction nodes for a specified rule. The ruleId parameter is required. You can further filter nodes by status. If the specified rule does not exist or is deleted, a success response with an empty list is returned.
RetryMemoryTask Retry a memory task Retries a failed memory task by reusing the original task ID, input, and extraction configuration. Only tasks in the FAILED state can be retried. You can query the progress by calling GetMemoryTask after the retry.
RevokeMemory Invalidate a memory Invalidates the specified memory while retaining its content. After revocation, the memory no longer participates in retrieval as a valid memory and can be queried by setting valid=false in ListMemories. Repeated revocations return a success response.
UpdateMemoryRule Update a memory rule Updates the name, description, enabled status, or extraction strategy of a memory rule. You must specify at least one field to update. Unspecified fields retain their original values.
UpdateServiceEndpoint Update a service endpoint Updates a service endpoint.