Agent Configuration Model

The Agent Configuration model contains all the information and data related to an agent configuration.

Properties

  • Name
    sId
    Type
    string
    Description

    Unique identifier for the agent configuration.

  • Name
    scope
    Type
    AgentConfigurationScope
    Description

    The scope of the agent configuration. It can be either global or workspace.

  • Name
    status
    Type
    AgentConfigurationStatus
    Description

    Status of the agent configuration. It can be one of the following: active, archived, disabled_by_admin, disabled_missing_datasource, disabled_free_workspace.

  • Name
    name
    Type
    string
    Description

    The name of the agent.

  • Name
    description
    Type
    string
    Description

    A description of the agent.

  • Name
    pictureUrl
    Type
    string
    Description

    The URL of the agent's picture.

GET/v1/w/:workspace_id/assistant/agent_configurations

Retrieve Agent Configurations

This endpoint allows you to retrieve a list of Agent Configurations. Each Agent Configuration includes details about the agent's scope, status, name, description, and picture URL.

URL attributes

  • Name
    workspace_id
    Type
    string
    Description

    The ID of the workspace (can be found in the workspace's URL)

Request

GET
/v1/w/:workspace_id/assistant/agent_configurations
curl https://dust.tt/api/v1/w/workspace1/assistant/agent_configurations \
  -H "Authorization: Bearer sk-..." \

Response

{
  "agentConfigurations": [
    {
      "sId": "dust",
      "scope": "global",
      "status": "active",
      "name": "Dust Assistant",
      "description": "An assistant with context on your company data.",
      "pictureUrl": "https://dust.tt/static/systemavatar/dust_avatar_full.png"
    },
    ...
  ]
}