Dust

https://docs.dust.tt/
Admin
Dust is a developer platform for creating and deploying AI agents with comprehensive guides, API...
Tokens:215,079
Snippets:1,733
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example Agent Instructions for HubSpot Interaction

Source: https://docs.dust.tt/docs/user-documentation/agents/tools/hubspot

Use these instructions to guide the agent on interacting with HubSpot objects like contacts and deals.

```text
From the transcripts you are receiving, create a contact if you can't find any existing contact with the interlocutor's name or email, and if a deal has been set create a deal to attach to the current account.
```

--------------------------------

### Install Dust CLI

Source: https://docs.dust.tt/docs/developer-platform/dust-cli/dust-cli

Install the Dust CLI globally using npm.

```bash
npm install -g @dust-tt/dust-cli
```

--------------------------------

### Installation of Dropbox Sync Script

Source: https://docs.dust.tt/docs/user-documentation/data-sources/custom-connections/beta-import-dropbox-files

Clone the repository and install the necessary dependencies to begin using the sync tool.

```bash
git clone git@github.com:dust-tt/dust-labs.git
cd dust-labs/dropbox
npm install
```

--------------------------------

### Chat Command Examples

Source: https://docs.dust.tt/docs/developer-platform/dust-cli/dust-cli

Examples of interactive and non-interactive chat usage.

```bash
# Interactive: pick an agent by name
dust chat --agent "My Agent"

# Non-interactive: single message, JSON response on stdout
dust chat --agent "My Agent" --message "Summarize Q4 metrics"

# Non-interactive: continue an existing conversation
dust chat -a "My Agent" -m "Add a bullet for next steps" -c <conversationId>
```

--------------------------------

### Agent Instructions for Snowflake

Source: https://docs.dust.tt/docs/user-documentation/agents/tools/snowflake

Example instructions to guide an agent in exploring and querying a Snowflake data warehouse.

```text
Our data warehouse is organized as follows:
- ANALYTICS database: contains our main reporting tables
- RAW database: contains raw ingested data

When querying Snowflake:
- Always start by exploring the schema using list_databases, list_schemas, list_tables, and describe_table before writing queries.
- Only use SELECT queries. Write operations are not supported.
- Prefer specific columns over SELECT * for better performance.
- Results are limited to 1000 rows per query.
```

--------------------------------

### File Generation Prompt Examples

Source: https://docs.dust.tt/docs/user-documentation/agents/tools/file-generation

Examples of natural language prompts used to trigger file generation or conversion tasks within an agent conversation.

```text
Please create a PDF report summarizing the quarterly sales data we discussed.
```

```text
Convert this markdown file to a Word document.
```

```text
Create an Excel file with the project timeline we outlined.
```

--------------------------------

### Context Object Schema Examples

Source: https://docs.dust.tt/api-reference/conversations/create-a-content-fragment

Example values for user context fields such as username, timezone, and agentic message metadata.

```yaml
username:
  type: string
  description: Username in the current context
  example: johndoe123
timezone:
  type: string
  description: User's timezone
  example: America/New_York
fullName:
  type: string
  description: User's full name in the current context
  example: John Doe
email:
  type: string
  description: User's email in the current context
  example: john.doe@example.com
profilePictureUrl:
  type: string
  description: URL of the user's profile picture
  example: https://example.com/profiles/johndoe123.jpg
originMessageId:
  type: string
  description: ID of the origin message
  example: 2b8e4f6a0c
```

--------------------------------

### Content Fragment Schema Examples

Source: https://docs.dust.tt/api-reference/conversations/create-a-content-fragment

Example values for content fragment properties including file processing status, node IDs, and data source view IDs.

```yaml
example: conversation/voice.processed.txt
nodeId:
  type: string
  description: >-
    The id of the content node (optional if `content` and `contentType`
    are set)
  example: node_123456
nodeDataSourceViewId:
  type: string
  description: >-
    The id of the data source view (optional if `content` and
    `contentType` are set)
  example: dsv_123456
```

--------------------------------

### Simple Filter Example

Source: https://docs.dust.tt/docs/user-documentation/agents/triggers/webhooks/filter-webhooks-payload

Filter events based on a single action type.

```text
(eq "action" "opened")
```

--------------------------------

### Webhook Filter Expression Examples

Source: https://docs.dust.tt/docs/user-documentation/agents/triggers/webhooks/filter-webhooks-payload

Incremental steps for building a filter expression based on a sample JSON payload.

```text
Payload: {"action": "opened", "issue": {"labels": ["bug"]}}

Step 1: (eq "action" "opened")
Step 2: (has "issue.labels" "bug")
Step 3: (and (eq "action" "opened") (has "issue.labels" "bug"))
```

--------------------------------

### Example webhook payload

Source: https://docs.dust.tt/docs/user-documentation/agents/triggers/webhooks/filter-webhooks-payload

A sample JSON structure representing a webhook payload used to demonstrate field access and data types.

```json
{
  "action": "opened",
  "issue": {
    "number": 42,
    "state": "open",
    "labels": ["bug", "critical"]
  },
  "tags": [
    {"name": "bug", "id": 1},
    {"name": "feature", "id": 2}
  ]
}
```

--------------------------------

### GET /api/v1/me

Source: https://docs.dust.tt/reference/openapi

Retrieves the profile of the currently authenticated user, including their workspaces and account settings.

```APIDOC
## GET /api/v1/me

### Description
Retrieves the authenticated user's profile information, including their workspaces, roles, and account metadata.

### Method
GET

### Endpoint
/api/v1/me

### Parameters
#### Authorizations
- **Authorization** (string) - Required - Your DUST API key as a Bearer token in the header.

### Response
#### Success Response (200)
- **user** (object) - Authenticated user with their workspaces and subscriber hash.

#### Response Example
{
  "user": {
    "sId": "<string>",
    "id": 123,
    "createdAt": 123,
    "username": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "workspaces": [
      {
        "id": 123,
        "sId": "<string>",
        "name": "<string>",
        "role": "admin",
        "regionalModelsOnly": true,
        "segmentation": "<string>",
        "whiteListedProviders": ["<string>"],
        "defaultEmbeddingProvider": "<string>",
        "ssoEnforced": true,
        "metadata": {}
      }
    ],
    "provider": "auth0",
    "lastName": "<string>",
    "image": "<string>",
    "lastLoginAt": 123,
    "selectedWorkspace": "<string>",
    "origin": "<string>",
    "subscriberHash": "<string>"
  }
}
```

--------------------------------

### GET /api/user

Source: https://docs.dust.tt/reference/openapi

Retrieves the profile information for the currently authenticated user, including their associated workspaces and account metadata.

```APIDOC
## GET /api/user

### Description
Retrieves the profile information for the currently authenticated user, including their associated workspaces and account metadata.

### Method
GET

### Endpoint
https://dust.tt/api/user

### Response
#### Success Response (200)
- **user** (object) - The user profile object containing details such as username, email, and a list of workspaces.

#### Response Example
{
  "user": {
    "sId": "<string>",
    "id": 123,
    "createdAt": 123,
    "username": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "workspaces": [
      {
        "id": 123,
        "sId": "<string>",
        "name": "<string>",
        "role": "admin",
        "regionalModelsOnly": true,
        "segmentation": "<string>",
        "whiteListedProviders": [
          "<string>"
        ],
        "defaultEmbeddingProvider": "<string>",
        "ssoEnforced": true,
        "metadata": {}
      }
    ],
    "provider": "auth0",
    "lastName": "<string>",
    "image": "<string>",
    "lastLoginAt": 123,
    "selectedWorkspace": "<string>",
    "origin": "<string>",
    "subscriberHash": "<string>"
  }
}
```

--------------------------------

### Display Help

Source: https://docs.dust.tt/docs/developer-platform/dust-cli/dust-cli

Show help information for the CLI.

```bash
dust help
```

--------------------------------

### OpenAPI specification for Get a space

Source: https://docs.dust.tt/api-reference/private-spaces/get-a-space

The OpenAPI definition for the GET /api/w/{wId}/spaces/{spaceId} endpoint.

```yaml
openapi: 3.0.0
info:
  title: DUST API Documentation
  version: 1.0.2
  description: The OpenAPI specification for the Dust.tt API
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://dust.tt
    description: Dust.tt API (us-central1)
  - url: https://eu.dust.tt
    description: Dust.tt API (europe-west1)
security: []
tags:
  - name: Agents
    description: Agent configurations
  - name: Apps
    description: Dust apps
  - name: Conversations
    description: Conversations
  - name: DatasourceViews
    description: Data source views
  - name: Datasources
    description: Data sources
  - name: Feedbacks
    description: Message feedbacks
  - name: MCP
    description: MCP servers
  - name: Mentions
    description: Mentions
  - name: Search
    description: Search
  - name: Tools
    description: Tools
  - name: Triggers
    description: Triggers
  - name: Skills
    description: Skills
  - name: Spaces
    description: Spaces
  - name: Workspace
    description: Workspace
  - name: Private User
    description: Private API - User
  - name: Private Authentication
    description: Private API - Authentication (WorkOS)
  - name: Private Agents
    description: Private API - Agent configurations
  - name: Private Conversations
    description: Private API - Conversations
  - name: Private Messages
    description: Private API - Messages
  - name: Private Events
    description: Private API - SSE event streams
  - name: Private Files
    description: Private API - File uploads
  - name: Private Mentions
    description: Private API - Mention suggestions
  - name: Private Spaces
    description: Private API - Spaces and data source views
  - name: Private Extension
    description: Private API - Extension configuration
  - name: Private Workspace
    description: Private API - Workspace settings
paths:
  /api/w/{wId}/spaces/{spaceId}:
    get:
      tags:
        - Private Spaces
      summary: Get a space
      description: >-
        Returns the details of a specific space including categories, members,
        and permissions.
      parameters:
        - in: path
          name: wId
          required: true
          description: ID of the workspace
          schema:
            type: string
        - in: path
          name: spaceId
          required: true
          description: ID of the space
          schema:
            type: string
        - in: query
          name: includeAllMembers
          required: false
          description: Include all members (including inactive)
          schema:
            type: string
            enum:
              - 'true'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  space:
                    allOf:
                      - $ref: '#/components/schemas/PrivateSpace'
                      - type: object
                        properties:
                          groupIds:
                            type: array
                            items:
                              type: string
                          isRestricted:
                            type: boolean
                          categories:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                count:
                                  type: integer
                                usage:
                                  type: object
                                  properties:
                                    count:
                                      type: integer
                                    agents:
                                      type: array
                                      items:
                                        type: object
                          canWrite:
                            type: boolean
                          canRead:
                            type: boolean
                          isMember:
                            type: boolean
                          isEditor:
                            type: boolean
                          members:
                            type: array
                            items:
                              type: object
                          description:
                            type: string
```

--------------------------------

### E-commerce Product Photography Pipeline Prompt

Source: https://docs.dust.tt/docs/user-documentation/agents/tools/image-generation

Example prompt for generating a multi-asset product photography suite with consistent appearance.

```text
Create a complete e-commerce photography suite for a premium leather handbag:
1. Female model in a city shot
2. Close-up detail showing leather texture and stitching
3. Lifestyle context shot on a marble surface with sunglasses and coffee
4. Scale reference next to a smartphone
5. Square format version for Instagram feed
Maintain consistent product appearance across all images.
```

--------------------------------

### OpenAPI Specification for Get a single action

Source: https://docs.dust.tt/api-reference/private-messages/get-a-single-action

Defines the GET endpoint for retrieving an action by workspace, conversation, message, and action IDs.

```yaml
openapi: 3.0.0
info:
  title: DUST API Documentation
  version: 1.0.2
  description: The OpenAPI specification for the Dust.tt API
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://dust.tt
    description: Dust.tt API (us-central1)
  - url: https://eu.dust.tt
    description: Dust.tt API (europe-west1)
security: []
tags:
  - name: Agents
    description: Agent configurations
  - name: Apps
    description: Dust apps
  - name: Conversations
    description: Conversations
  - name: DatasourceViews
    description: Data source views
  - name: Datasources
    description: Data sources
  - name: Feedbacks
    description: Message feedbacks
  - name: MCP
    description: MCP servers
  - name: Mentions
    description: Mentions
  - name: Search
    description: Search
  - name: Tools
    description: Tools
  - name: Triggers
    description: Triggers
  - name: Skills
    description: Skills
  - name: Spaces
    description: Spaces
  - name: Workspace
    description: Workspace
  - name: Private User
    description: Private API - User
  - name: Private Authentication
    description: Private API - Authentication (WorkOS)
  - name: Private Agents
    description: Private API - Agent configurations
  - name: Private Conversations
    description: Private API - Conversations
  - name: Private Messages
    description: Private API - Messages
  - name: Private Events
    description: Private API - SSE event streams
  - name: Private Files
    description: Private API - File uploads
  - name: Private Mentions
    description: Private API - Mention suggestions
  - name: Private Spaces
    description: Private API - Spaces and data source views
  - name: Private Extension
    description: Private API - Extension configuration
  - name: Private Workspace
    description: Private API - Workspace settings
paths:
  /api/w/{wId}/assistant/conversations/{cId}/messages/{mId}/actions/{aId}:
    get:
      tags:
        - Private Messages
      summary: Get a single action
      description: >-
        Retrieve a single action by its ID within an agent message, along with
        the message status.
      parameters:
        - in: path
          name: wId
          required: true
          description: ID of the workspace
          schema:
            type: string
        - in: path
          name: cId
          required: true
          description: ID of the conversation
          schema:
            type: string
        - in: path
          name: mId
          required: true
          description: ID of the message
          schema:
            type: string
        - in: path
          name: aId
          required: true
          description: ID of the action
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved the action
          content:
            application/json:
              schema:
                type: object
                properties:
                  action:
                    $ref: '#/components/schemas/PrivateAgentMCPAction'
                  messageStatus:
                    type: string
                    enum:
                      - created
                      - succeeded
                      - failed
                      - cancelled
                      - gracefully_stopped
        '400':
          description: >-
            Invalid request (missing parameters or message is not an agent
            message)
        '401':
          description: Unauthorized
        '404':
          description: Conversation, message, or action not found
      security:
        - BearerAuth: []
components:
  schemas:
    PrivateAgentMCPAction:
      type: object
      description: An MCP action with its output.
      required:
        - id
        - sId
        - createdAt
        - updatedAt
        - agentMessageId
        - toolName
        - functionCallName
        - functionCallId
        - params
        - citationsAllocated
        - status
        - step
        - generatedFiles
        - output
      properties:
        id:
          type: integer
          description: Numeric model identifier
        sId:
          type: string
          description: Unique string identifier
        createdAt:
          type: integer
          description: Unix timestamp of creation
        updatedAt:
          type: integer
          description: Unix timestamp of last update
        agentMessageId:
          type: integer
```

--------------------------------

### Create a file upload request

Source: https://docs.dust.tt/api-reference/private-files/create-a-file-upload

Examples of how to initiate a file upload request using various programming languages.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://dust.tt/api/w/{wId}/files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'contentType' => '<string>',
    'fileName' => '<string>',
    'fileSize' => 123,
    'useCaseMetadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://dust.tt/api/w/{wId}/files"

	payload := strings.NewReader("{\n  \"contentType\": \"<string>\",\n  \"fileName\": \"<string>\",\n  \"fileSize\": 123,\n  \"useCaseMetadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.post("https://dust.tt/api/w/{wId}/files")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contentType\": \"<string>\",\n  \"fileName\": \"<string>\",\n  \"fileSize\": 123,\n  \"useCaseMetadata\": {}\n}")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://dust.tt/api/w/{wId}/files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contentType\": \"<string>\",\n  \"fileName\": \"<string>\",\n  \"fileSize\": 123,\n  \"useCaseMetadata\": {}\n}"

response = http.request(request)
puts response.read_body
```

--------------------------------

### Get a row OpenAPI specification

Source: https://docs.dust.tt/api-reference/datasources/get-a-row

The OpenAPI definition for the GET request to retrieve a row, including path parameters and security requirements.

```yaml
openapi: 3.0.0
info:
  title: DUST API Documentation
  version: 1.0.2
  description: The OpenAPI specification for the Dust.tt API
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://dust.tt
    description: Dust.tt API (us-central1)
  - url: https://eu.dust.tt
    description: Dust.tt API (europe-west1)
security: []
tags:
  - name: Agents
    description: Agent configurations
  - name: Apps
    description: Dust apps
  - name: Conversations
    description: Conversations
  - name: DatasourceViews
    description: Data source views
  - name: Datasources
    description: Data sources
  - name: Feedbacks
    description: Message feedbacks
  - name: MCP
    description: MCP servers
  - name: Mentions
    description: Mentions
  - name: Search
    description: Search
  - name: Tools
    description: Tools
  - name: Triggers
    description: Triggers
  - name: Skills
    description: Skills
  - name: Spaces
    description: Spaces
  - name: Workspace
    description: Workspace
  - name: Private User
    description: Private API - User
  - name: Private Authentication
    description: Private API - Authentication (WorkOS)
  - name: Private Agents
    description: Private API - Agent configurations
  - name: Private Conversations
    description: Private API - Conversations
  - name: Private Messages
    description: Private API - Messages
  - name: Private Events
    description: Private API - SSE event streams
  - name: Private Files
    description: Private API - File uploads
  - name: Private Mentions
    description: Private API - Mention suggestions
  - name: Private Spaces
    description: Private API - Spaces and data source views
  - name: Private Extension
    description: Private API - Extension configuration
  - name: Private Workspace
    description: Private API - Workspace settings
paths:
  /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/tables/{tId}/rows/{rId}:
    get:
      tags:
        - Datasources
      summary: Get a row
      description: >-
        Get a row in the table identified by {tId} in the data source identified
        by {dsId} in the workspace identified by {wId}.
      parameters:
        - in: path
          name: wId
          required: true
          description: Unique string identifier for the workspace
          schema:
            type: string
        - in: path
          name: spaceId
          required: true
          description: ID of the space
          schema:
            type: string
        - in: path
          name: dsId
          required: true
          description: ID of the data source
          schema:
            type: string
        - in: path
          name: tId
          required: true
          description: ID of the table
          schema:
            type: string
        - in: path
          name: rId
          required: true
          description: ID of the row
          schema:
            type: string
      responses:
        '200':
          description: The row
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Datasource'
        '404':
          description: The row was not found
      security:
        - BearerAuth: []
components:
  schemas:
    Datasource:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the datasource
          example: 12345
        createdAt:
          type: integer
          description: Timestamp of when the datasource was created
          example: 1625097600
        name:
          type: string
          description: Name of the datasource
          example: Customer Knowledge Base
        description:
          type: string
          description: Description of the datasource
          example: Contains all customer-related information and FAQs
        dustAPIProjectId:
          type: string
          description: ID of the associated Dust API project
          example: 5e9d8c7b6a
        connectorId:
          type: string
          description: ID of the connector used for this datasource
          example: 1f3e5d7c9b
        connectorProvider:
          type: string
          description: Provider of the connector (e.g., 'webcrawler')
          example: webcrawler
        assistantDefaultSelected:
          type: boolean
          description: Whether this datasource is selected by default for agents
          example: true
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Your DUST API key is a Bearer token.
```

--------------------------------

### OpenAPI Specification for Get Conversation Events

Source: https://docs.dust.tt/api-reference/conversations/get-the-events-for-a-conversation

Defines the GET endpoint for retrieving events from a conversation using workspace and conversation IDs.

```yaml
openapi: 3.0.0
info:
  title: DUST API Documentation
  version: 1.0.2
  description: The OpenAPI specification for the Dust.tt API
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://dust.tt
    description: Dust.tt API (us-central1)
  - url: https://eu.dust.tt
    description: Dust.tt API (europe-west1)
security: []
tags:
  - name: Agents
    description: Agent configurations
  - name: Apps
    description: Dust apps
  - name: Conversations
    description: Conversations
  - name: DatasourceViews
    description: Data source views
  - name: Datasources
    description: Data sources
  - name: Feedbacks
    description: Message feedbacks
  - name: MCP
    description: MCP servers
  - name: Mentions
    description: Mentions
  - name: Search
    description: Search
  - name: Tools
    description: Tools
  - name: Triggers
    description: Triggers
  - name: Skills
    description: Skills
  - name: Spaces
    description: Spaces
  - name: Workspace
    description: Workspace
  - name: Private User
    description: Private API - User
  - name: Private Authentication
    description: Private API - Authentication (WorkOS)
  - name: Private Agents
    description: Private API - Agent configurations
  - name: Private Conversations
    description: Private API - Conversations
  - name: Private Messages
    description: Private API - Messages
  - name: Private Events
    description: Private API - SSE event streams
  - name: Private Files
    description: Private API - File uploads
  - name: Private Mentions
    description: Private API - Mention suggestions
  - name: Private Spaces
    description: Private API - Spaces and data source views
  - name: Private Extension
    description: Private API - Extension configuration
  - name: Private Workspace
    description: Private API - Workspace settings
paths:
  /api/v1/w/{wId}/assistant/conversations/{cId}/events:
    get:
      tags:
        - Conversations
      summary: Get the events for a conversation
      description: Get the events for a conversation in the workspace identified by {wId}.
      parameters:
        - in: path
          name: wId
          required: true
          description: ID of the workspace
          schema:
            type: string
        - in: path
          name: cId
          required: true
          description: ID of the conversation
          schema:
            type: string
        - in: query
          name: lastEventId
          required: false
          description: ID of the last event
          schema:
            type: string
      responses:
        '200':
          description: >-
            Events for the conversation, view the "Events" page from this
            documentation for more information.
        '400':
          description: Bad Request. Missing or invalid parameters.
        '401':
          description: Unauthorized. Invalid or missing authentication token.
        '404':
          description: Conversation not found.
        '500':
          description: Internal Server Error.
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Your DUST API key is a Bearer token.
```

--------------------------------

### PowerPoint File Manipulation Prompts

Source: https://docs.dust.tt/docs/user-documentation/agents/tools/computer

Example prompts for creating, updating, and styling presentation decks.

```text
Use this PowerPoint as a template and this CSV as the data source. Create a 10-slide QBR deck with charts and a final recommendations slide.
```

```text
Update slides 4 through 7 with the new metrics from this Excel workbook. Keep the same layout and return an updated .pptx.
```

```text
Turn these meeting notes into a short executive deck. Use the uploaded deck as the style reference.
```

--------------------------------

### OpenAPI Specification for Get Project Notification Preference

Source: https://docs.dust.tt/api-reference/private-spaces/get-project-notification-preference

Defines the GET endpoint for retrieving notification preferences, requiring workspace and space identifiers.

```yaml
openapi: 3.0.0
info:
  title: DUST API Documentation
  version: 1.0.2
  description: The OpenAPI specification for the Dust.tt API
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://dust.tt
    description: Dust.tt API (us-central1)
  - url: https://eu.dust.tt
    description: Dust.tt API (europe-west1)
security: []
tags:
  - name: Agents
    description: Agent configurations
  - name: Apps
    description: Dust apps
  - name: Conversations
    description: Conversations
  - name: DatasourceViews
    description: Data source views
  - name: Datasources
    description: Data sources
  - name: Feedbacks
    description: Message feedbacks
  - name: MCP
    description: MCP servers
  - name: Mentions
    description: Mentions
  - name: Search
    description: Search
  - name: Tools
    description: Tools
  - name: Triggers
    description: Triggers
  - name: Skills
    description: Skills
  - name: Spaces
    description: Spaces
  - name: Workspace
    description: Workspace
  - name: Private User
    description: Private API - User
  - name: Private Authentication
    description: Private API - Authentication (WorkOS)
  - name: Private Agents
    description: Private API - Agent configurations
  - name: Private Conversations
    description: Private API - Conversations
  - name: Private Messages
    description: Private API - Messages
  - name: Private Events
    description: Private API - SSE event streams
  - name: Private Files
    description: Private API - File uploads
  - name: Private Mentions
    description: Private API - Mention suggestions
  - name: Private Spaces
    description: Private API - Spaces and data source views
  - name: Private Extension
    description: Private API - Extension configuration
  - name: Private Workspace
    description: Private API - Workspace settings
paths:
  /api/w/{wId}/spaces/{spaceId}/project_notification_preferences:
    get:
      tags:
        - Private Spaces
      summary: Get project notification preference
      description: Returns the current user's notification preference for a project space.
      parameters:
        - in: path
          name: wId
          required: true
          description: ID of the workspace
          schema:
            type: string
        - in: path
          name: spaceId
          required: true
          description: ID of the project space
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  userProjectNotificationPreference:
                    type: object
                    nullable: true
                    properties:
                      sId:
                        type: string
                      spaceId:
                        type: string
                      userId:
                        type: string
                      preference:
                        type: string
                        enum:
                          - all_messages
                          - only_mentions
                          - never
        '400':
          description: Bad request (space is not a project)
        '401':
          description: Unauthorized
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Your DUST API key is a Bearer token.
```

--------------------------------

### Real Estate Property Staging Prompt

Source: https://docs.dust.tt/docs/user-documentation/agents/tools/image-generation

Example prompt for generating multiple furniture variations while maintaining consistent room architecture.

```text
Generate a property staging showcase:
1. Base room: modern minimalist living room with large windows, hardwood floors, neutral colors, architectural visualization style
2. Three alternative furniture styles: mid-century modern, Scandinavian minimalist with light wood, and industrial with metal accents
Maintain the exact same room architecture across all variations.
```

--------------------------------

### OpenAPI Specification for Get Workspace Feature Flags

Source: https://docs.dust.tt/api-reference/private-workspace/get-workspace-feature-flags

Defines the GET endpoint for retrieving feature flags, requiring a workspace ID and Bearer authentication.

```yaml
openapi: 3.0.0
info:
  title: DUST API Documentation
  version: 1.0.2
  description: The OpenAPI specification for the Dust.tt API
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://dust.tt
    description: Dust.tt API (us-central1)
  - url: https://eu.dust.tt
    description: Dust.tt API (europe-west1)
security: []
tags:
  - name: Agents
    description: Agent configurations
  - name: Apps
    description: Dust apps
  - name: Conversations
    description: Conversations
  - name: DatasourceViews
    description: Data source views
  - name: Datasources
    description: Data sources
  - name: Feedbacks
    description: Message feedbacks
  - name: MCP
    description: MCP servers
  - name: Mentions
    description: Mentions
  - name: Search
    description: Search
  - name: Tools
    description: Tools
  - name: Triggers
    description: Triggers
  - name: Skills
    description: Skills
  - name: Spaces
    description: Spaces
  - name: Workspace
    description: Workspace
  - name: Private User
    description: Private API - User
  - name: Private Authentication
    description: Private API - Authentication (WorkOS)
  - name: Private Agents
    description: Private API - Agent configurations
  - name: Private Conversations
    description: Private API - Conversations
  - name: Private Messages
    description: Private API - Messages
  - name: Private Events
    description: Private API - SSE event streams
  - name: Private Files
    description: Private API - File uploads
  - name: Private Mentions
    description: Private API - Mention suggestions
  - name: Private Spaces
    description: Private API - Spaces and data source views
  - name: Private Extension
    description: Private API - Extension configuration
  - name: Private Workspace
    description: Private API - Workspace settings
paths:
  /api/w/{wId}/feature-flags:
    get:
      tags:
        - Private Workspace
      summary: Get workspace feature flags
      description: Returns the list of enabled feature flags for the workspace.
      parameters:
        - in: path
          name: wId
          required: true
          description: ID of the workspace
          schema:
            type: string
      responses:
        '200':
          description: List of feature flags
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateFeatureFlags'
        '401':
          description: Unauthorized
      security:
        - BearerAuth: []
components:
  schemas:
    PrivateFeatureFlags:
      type: object
      description: Workspace feature flags response.
      required:
        - feature_flags
      properties:
        feature_flags:
          type: array
          items:
            type: string
          description: List of enabled feature flag names for the workspace
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Your DUST API key is a Bearer token.
```

--------------------------------

### Create and Connect a Client-Side MCP Server

Source: https://docs.dust.tt/docs/client-side-mcp-server

Initializes an McpServer instance, registers tools for ticket management, and connects it to the Dust platform using the DustMcpServerTransport.

```typescript
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { DustMcpServerTransport } from "@dust-tt/client";
import { z } from "zod";

// Create the server.
const server = new McpServer({
  name: "ticket-cli",
  version: "1.0.0",
});

// Expose ticket management tools.
server.tool(
  "search_tickets",
  "Search tickets in the internal system",
  {
    query: z.string().describe("Search query (e.g., 'status:open priority:high')"),
    limit: z.number().describe("Maximum number of results").default(10)
  },
  async ({ query, limit }) => {
    // Your implementation using internal ticket system API.
    const tickets = await ticketSystem.search(query, limit);
    return { tickets };
  }
);

server.tool(
  "update_ticket",
  "Update ticket status and assignee",
  {
    ticketId: z.string().describe("Ticket ID"),
    status: z.enum(["open", "in_progress", "blocked", "resolved"]),
    assignee: z.string().optional().describe("User ID to assign the ticket to"),
    comment: z.string().optional().describe("Optional comment to add")
  },
  async (params) => {
    // Your implementation using ticket system API.
    const ticket = await ticketSystem.update(params);
    return {
      ticketId: ticket.id,
      status: ticket.status,
      assignee: ticket.assignee
    };
  }
);

// Connect to Dust.
const transport = new DustMcpServerTransport(dustAPI);
await server.connect(transport);

// Get the server ID to use in conversations.
const serverId = transport.getServerId();
```

--------------------------------

### Retrieve OAuth Client Credentials

Source: https://docs.dust.tt/docs/user-documentation/agents/tools/snowflake

Run this command to obtain the Client ID and Client Secret needed for the integration setup.

```sql
SELECT SYSTEM$SHOW_OAUTH_CLIENT_SECRETS('DUST_OAUTH');
```

--------------------------------

### OpenAPI Specification for Get a table

Source: https://docs.dust.tt/api-reference/datasources/get-a-table

Defines the GET endpoint for retrieving table information using workspace, space, data source, and table identifiers.

```yaml
openapi: 3.0.0
info:
  title: DUST API Documentation
  version: 1.0.2
  description: The OpenAPI specification for the Dust.tt API
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://dust.tt
    description: Dust.tt API (us-central1)
  - url: https://eu.dust.tt
    description: Dust.tt API (europe-west1)
security: []
tags:
  - name: Agents
    description: Agent configurations
  - name: Apps
    description: Dust apps
  - name: Conversations
    description: Conversations
  - name: DatasourceViews
    description: Data source views
  - name: Datasources
    description: Data sources
  - name: Feedbacks
    description: Message feedbacks
  - name: MCP
    description: MCP servers
  - name: Mentions
    description: Mentions
  - name: Search
    description: Search
  - name: Tools
    description: Tools
  - name: Triggers
    description: Triggers
  - name: Skills
    description: Skills
  - name: Spaces
    description: Spaces
  - name: Workspace
    description: Workspace
  - name: Private User
    description: Private API - User
  - name: Private Authentication
    description: Private API - Authentication (WorkOS)
  - name: Private Agents
    description: Private API - Agent configurations
  - name: Private Conversations
    description: Private API - Conversations
  - name: Private Messages
    description: Private API - Messages
  - name: Private Events
    description: Private API - SSE event streams
  - name: Private Files
    description: Private API - File uploads
  - name: Private Mentions
    description: Private API - Mention suggestions
  - name: Private Spaces
    description: Private API - Spaces and data source views
  - name: Private Extension
    description: Private API - Extension configuration
  - name: Private Workspace
    description: Private API - Workspace settings
paths:
  /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/tables/{tId}:
    get:
      tags:
        - Datasources
      summary: Get a table
      description: >-
        Get a table in the data source identified by {dsId} in the workspace
        identified by {wId}.
      parameters:
        - in: path
          name: wId
          required: true
          description: Unique string identifier for the workspace
          schema:
            type: string
        - in: path
          name: spaceId
          required: true
          description: ID of the space
          schema:
            type: string
        - in: path
          name: dsId
          required: true
          description: ID of the data source
          schema:
            type: string
        - in: path
          name: tId
          required: true
          description: ID of the table
          schema:
            type: string
      responses:
        '200':
          description: The table
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Table'
        '404':
          description: The table was not found
      security:
        - BearerAuth: []
components:
  schemas:
    Table:
      type: object
      properties:
        name:
          type: string
          description: Name of the table
          example: Roi data
          deprecated: true
        title:
          type: string
          description: Title of the table
          example: ROI Data
        table_id:
          type: string
          description: Unique identifier for the table
          example: 1234f4567c
        description:
          type: string
          description: Description of the table
          example: roi data for Q1
        mime_type:
          type: string
          description: MIME type of the table
          example: text/csv
        schema:
          type: array
          description: Array of column definitions
          items:
            type: object
            properties:
              name:
                type: string
                description: Name of the column
                example: roi
              value_type:
                type: string
                description: Data type of the column
                enum:
                  - text
                  - int
                  - float
                  - bool
                  - date
                example: int
              possible_values:
                type: array
                description: Array of possible values for the column (null if unrestricted)
                items:
                  type: string
```
Tokens:
Raw