All Products
Search

This Product

    DataWorks:CreateAgent

    Document Center

    DataWorks:CreateAgent

    Last Updated:Jun 11, 2026

    Create Agent

    Operation description

    Request Description

    • Agent Name: Must be unique under the current account.

    • Model Configuration: An optional parameter used to specify the model used by the Agent and its related settings.

    • Visibility Level: Defines who can access the Agent. Supports visibility within the account, to specified projects, or to specific users.

    • Visibility Scope: When PROJECT or USER is selected as the visibility level, the specific project ID or user ID list must be further specified.

    • Other Parameters: Items such as display name and description are optional and can be filled in based on actual needs.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Name

    string

    Yes

    The name of the Agent. It must be unique under the current account.

    my-agent
    DisplayName

    string

    No

    The display name of the Agent.

    我的助手
    Description

    string

    No

    The description of the Agent.

    数据分析助手
    Model

    object

    No

    The model configuration.

    { "modelName": "dataworks-public-bailian/qwen-max" }
    SystemPrompt

    string

    No

    The system prompt.

    你是一个数据分析助手。
    Tools

    array

    No

    The list of tools.

    -

    string

    No

    Tool information.

    -
    Skills

    array

    No

    The list of skills.

    -

    string

    No

    Skill configuration.

    ["my-skill"]
    CallableAgents

    array

    No

    The list of sub-Agents that can be called by this Agent.

    -

    string

    No

    Agent name.

    ["agent-name"]
    Metadata

    object

    No

    Extended metadata (key-value pairs).

    {}
    Visibility

    string

    No

    The visibility level.
    TENANT: Visible within the account.
    PROJECT: Visible to specified projects.
    USER: Visible to specified users.

    TENANT
    VisibilityScope

    object

    No

    The visibility scope. The corresponding field is selected based on Visibility.

    ProjectIds

    array

    No

    The list of visible project IDs. Takes effect when Visibility is PROJECT.

    string

    No

    List of workspace IDs.

    [21791]
    UserIds

    array

    No

    The list of visible user IDs. Takes effect when Visibility is USER.

    string

    No

    The list of visible user IDs. Takes effect when Visibility is USER.

    []

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    824F80BA-1778-5D8A-BAFF-668A4D9C4CC7
    Agent

    object

    Details of the created Agent.

    Name

    string

    The name of the Agent.

    my-agent
    GmtCreateTime

    string

    The creation time (millisecond timestamp).

    1780555634000
    GmtModifiedTime

    string

    The last modification time (millisecond timestamp).

    1780555634000

    Examples

    Success response

    JSON format

    {
  "RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
  "Agent": {
    "Name": "my-agent",
    "GmtCreateTime": "1780555634000",
    "GmtModifiedTime": "1780555634000"
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.