Assistant Update API

Updates an existing assistant in your workspace. Only the fields you provide will be updated, allowing for partial updates without affecting other configuration.

Requires an API key with the ASSISTANT_API scope and access to the assistant you want to update.

Update Behavior

The update endpoint uses partial update semantics with specific behavior for different field types:

Partial updates - Only fields provided in the request are updated; omitted fields remain unchanged
Array fields replace - actions, inputFields, conversationStarters, and attachments completely replace existing values when provided
Empty arrays - Send [] to remove all actions/fields/attachments
Null handling - Send null for emoji, description, or instruction to clear them
Unchanged fields - Fields not included in the request retain their current values

Request Parameters

All fields are optional except assistantId:

Parameter	Type	Required	Description
`assistantId`	string	Yes	UUID of the assistant to update
`name`	string	No	Updated name (1-255 characters)
`description`	string	No	Updated description (max 256 chars, null to clear)
`emoji`	string	No	Updated emoji icon (null to clear)
`instruction`	string	No	Updated system prompt (max 16384 chars, null to clear)
`model`	string	No	Updated model UUID
`creativity`	number	No	Updated temperature between 0-1
`conversationStarters`	string[]	No	Updated array of suggested prompts (replaces existing)
`actions`	array	No	Updated array of actions (replaces existing)
`inputFields`	array	No	Updated array of form fields (replaces existing)
`attachments`	string[]	No	Updated array of attachment UUIDs (replaces existing)
`webSearch`	boolean	No	Updated web search capability setting
`imageGeneration`	boolean	No	Updated image generation capability setting
`dataAnalyst`	boolean	No	Updated code interpreter capability setting
`canvas`	boolean	No	Updated canvas capability setting

Array fields (actions, inputFields, conversationStarters, attachments) are replaced entirely, not merged. Always provide the complete desired array, including any existing items you want to keep.

Actions Configuration

Each action in the actions array should contain:

actionId (required) - UUID of the action from an enabled integration
requiresConfirmation (optional) - Whether to require user confirmation before executing

Input Fields Configuration

For inputFields array structure, see the Create Assistant API documentation.

Examples

Updating Basic Properties

const axios = require("axios");

async function updateAssistantName() {
  const response = await axios.patch(
    "https://api.langdock.com/api/public/assistant/v1/update",
    {
      assistantId: "550e8400-e29b-41d4-a716-446655440000",
      name: "Advanced Document Analyzer",
      description: "Analyzes documents with enhanced capabilities",
      creativity: 0.7
    },
    {
      headers: {
        Authorization: "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
      }
    }
  );

  console.log("Assistant updated:", response.data.message);
}

Validation Rules

The API enforces several validation rules:

Assistant access - Your API key must have access to the assistant
Workspace match - Assistant must belong to the same workspace as your API key
Model - If provided, must be in your workspace’s active models list
Actions - If provided, must belong to integrations enabled in your workspace
Attachments - If provided, must exist in your workspace and not be deleted
Name - If provided, must be between 1-255 characters
Description - If provided, maximum 256 characters
Instruction - If provided, maximum 16384 characters
Creativity - If provided, must be between 0 and 1

Response Format

Success Response (200 OK)

{
  status: "success";
  message: "Assistant updated successfully";
  assistant: {
    id: string;
    name: string;
    description: string;
    instruction: string;
    emojiIcon: string;
    model: string;
    temperature: number;
    conversationStarters: string[];
    inputType: "PROMPT" | "STRUCTURED";
    webSearchEnabled: boolean;
    imageGenerationEnabled: boolean;
    codeInterpreterEnabled: boolean;
    canvasEnabled: boolean;
    actions: Array<{
      actionId: string;
      requiresConfirmation: boolean;
    }>;
    inputFields: Array<{
      slug: string;
      type: string;
      label: string;
      description: string;
      required: boolean;
      order: number;
      options: string[];
      fileTypes: string[] | null;
    }>;
    attachments: string[];
    createdAt: string;
    updatedAt: string;
  };
}

Error Handling

try {
  const response = await axios.patch('https://api.langdock.com/api/public/assistant/v1/update', ...);
} catch (error) {
  if (error.response) {
    switch (error.response.status) {
      case 400:
        console.error('Invalid parameters:', error.response.data.message);
        break;
      case 401:
        console.error('Invalid or missing API key');
        break;
      case 403:
        console.error('Insufficient permissions - no access to this assistant');
        break;
      case 404:
        console.error('Assistant not found or resource not found (model, action, attachment)');
        break;
      case 500:
        console.error('Server error');
        break;
    }
  }
}

Best Practices

Preserving existing values: When updating array fields like actions or attachments, always include existing items you want to keep, as the entire array is replaced.

Fetch before update - If you need to preserve existing array values, fetch the current assistant configuration first
Incremental updates - Update only the fields that need to change
Validate attachments - Ensure attachment UUIDs are valid before including them
Test actions - Verify actions belong to enabled integrations before updating
Handle errors gracefully - Implement proper error handling for validation failures

Authorizations

Authorization

string

header

required

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Body

application/json

assistantId

string<uuid>

required

UUID of the assistant to update

name

string

Updated name

Required string length: 1 - 255

description

string | null

Updated description (null to clear)

Maximum string length: 256

emoji

string | null

Updated emoji icon (null to clear)

instruction

string | null

Updated system prompt (null to clear)

Maximum string length: 16384

inputType

enum<string>

Updated input type for the assistant

Available options:

PROMPT,

STRUCTURED

model

string<uuid>

Updated model UUID

creativity

number

Updated temperature

Required range: 0 <= x <= 1

conversationStarters

string[]

Updated array of suggested prompts (replaces existing)

actions

object[]

Updated array of actions (replaces existing)

Show child attributes

actions.actionId

string<uuid>

required

actions.requiresConfirmation

boolean

default:false

inputFields

object[]

Updated array of form fields (replaces existing)

Show child attributes

inputFields.slug

string

required

inputFields.type

enum<string>

required

Available options:

TEXT,

MULTI_LINE_TEXT,

NUMBER,

CHECKBOX,

FILE,

SELECT,

DATE

inputFields.label

string

required

inputFields.order

integer

required

Required range: x >= 0

inputFields.description

string

inputFields.required

boolean

default:false

inputFields.options

string[]

inputFields.fileTypes

string[]

attachments

string<uuid>[]

Updated array of attachment UUIDs (replaces existing)

webSearch

boolean

Updated web search capability setting

imageGeneration

boolean

Updated image generation capability setting

dataAnalyst

boolean

Updated code interpreter capability setting

canvas

boolean

Updated canvas capability setting

Response

Assistant updated successfully

status

enum<string>

required

Available options:

success

message

string

required

Example:

"Assistant updated successfully"

assistant

object

required

Show child attributes

assistant.id

string<uuid>

required

Unique identifier for the assistant

assistant.name

string

required

Name of the assistant

assistant.emojiIcon

string | null

required

Emoji icon for the assistant

assistant.model

string<uuid>

required

UUID of the model being used

assistant.temperature

number

required

Temperature/creativity setting for response generation

Required range: 0 <= x <= 1

assistant.inputType

enum<string>

required

Input type for the assistant

Available options:

PROMPT,

STRUCTURED

assistant.webSearchEnabled

boolean

required

Whether web search capability is enabled

assistant.imageGenerationEnabled

boolean

required

Whether image generation capability is enabled

assistant.codeInterpreterEnabled

boolean

required

Whether code interpreter/data analyst capability is enabled

assistant.canvasEnabled

boolean

required

Whether canvas capability is enabled

assistant.createdAt

string<date-time>

required

Timestamp when the assistant was created

assistant.updatedAt

string<date-time>

required

Timestamp when the assistant was last updated

assistant.description

string | null

Description of what the assistant does

assistant.instruction

string | null

System prompt/instructions for the assistant

assistant.conversationStarters

string[]

Array of suggested prompts to help users get started

assistant.actions

object[]

Array of action objects for custom integrations

Show child attributes

assistant.actions.actionId

string<uuid>

required

UUID of the action from an enabled integration

assistant.actions.requiresConfirmation

boolean

required

Whether user confirmation is required before executing

assistant.inputFields

object[]

Array of form field definitions (for STRUCTURED input type)

Show child attributes

assistant.inputFields.slug

string

required

Unique identifier for the field

assistant.inputFields.type

enum<string>

required

Field type

Available options:

TEXT,

MULTI_LINE_TEXT,

NUMBER,

CHECKBOX,

FILE,

SELECT,

DATE

assistant.inputFields.label

string

required

Display label for the field

assistant.inputFields.required

boolean

required

Whether the field is required

assistant.inputFields.order

integer

required

Display order (0-indexed)

Required range: x >= 0

assistant.inputFields.description

string

Help text for the field

assistant.inputFields.options

string[]

Options for SELECT type fields

assistant.inputFields.fileTypes

string[] | null

Allowed file types for FILE type fields

assistant.attachments

string<uuid>[]

Array of attachment UUIDs associated with the assistant

Overview

Completion API

Embedding API

Assistant API

Knowledge Folder API

Usage Export API

Assistant Update API

Update Behavior

Request Parameters

Actions Configuration

Input Fields Configuration

Examples

Updating Basic Properties

Validation Rules

Response Format

Success Response (200 OK)

Error Handling

Best Practices

Authorizations

Body

Response

Overview

Completion API

Embedding API

Assistant API

Knowledge Folder API

Usage Export API

​Update Behavior

​Request Parameters

​Actions Configuration

​Input Fields Configuration

​Examples

​Updating Basic Properties

​Validation Rules

​Response Format

​Success Response (200 OK)

​Error Handling

​Best Practices

Authorizations

Body

Response

Update Behavior

Request Parameters

Actions Configuration

Input Fields Configuration

Examples

Updating Basic Properties

Validation Rules

Response Format

Success Response (200 OK)

Error Handling

Best Practices