Agent Update API

Updates an existing agent

curl --request PATCH \
  --url https://api.langdock.com/agent/v1/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "instructions": "<string>",
  "description": "<string>",
  "temperature": 0.5,
  "model": "<string>",
  "capabilities": {
    "webSearch": true,
    "dataAnalyst": true,
    "imageGeneration": true
  },
  "actions": [
    "<unknown>"
  ],
  "vectorDb": [
    "<unknown>"
  ],
  "knowledgeFolderIds": [
    "<string>"
  ],
  "attachmentIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

PATCH

agent

update

Updates an existing agent

curl --request PATCH \
  --url https://api.langdock.com/agent/v1/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "instructions": "<string>",
  "description": "<string>",
  "temperature": 0.5,
  "model": "<string>",
  "capabilities": {
    "webSearch": true,
    "dataAnalyst": true,
    "imageGeneration": true
  },
  "actions": [
    "<unknown>"
  ],
  "vectorDb": [
    "<unknown>"
  ],
  "knowledgeFolderIds": [
    "<string>"
  ],
  "attachmentIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

⚠️ Using our API via a dedicated deployment? Just replace api.langdock.com with your deployment’s base URL: <deployment-url>/api/public

This is the new Agents API with native Vercel AI SDK compatibility. If you’re using the legacy Assistants API, see the migration guide.

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

Updates are applied to the agent’s draft only. The active (published) version remains unchanged until the agent is published from the Langdock UI.

Requires an API key with the AGENT_API scope and access to the agent 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 to clear it. For description and instruction, send an empty string "" to clear them
Unchanged fields - Fields not included in the request retain their current values

Request Parameters

Set any of the parameters below to overwrite the agent’s current settings. Fields you omit stay unchanged. Only agentId is required.

Parameter	Type	Required	Description
`agentId`	string	Yes	UUID of the agent to update
`name`	string	No	Agent name (1-80 characters)
`description`	string	No	Description (max 500 chars, `""` to clear)
`emoji`	string	No	Emoji icon (max 16 chars, null to clear)
`instruction`	string	No	System prompt (max 40000 chars, `""` to clear)
`model`	string	No	Model identifier (deployment name from the Models API)
`creativity`	number	No	Temperature between 0 and 1
`conversationStarters`	string[]	No	Suggested prompts, max 20, each 1-255 chars (replaces existing)
`actions`	array	No	Actions (replaces existing)
`inputFields`	array	No	Form fields (replaces existing)
`attachments`	string[]	No	Attachment UUIDs (replaces existing)
`webSearch`	boolean	No	Enable web search
`imageGeneration`	boolean	No	Enable image generation
`dataAnalyst`	boolean	No	Enable code interpreter
`inputType`	string	No	Input type: “PROMPT” or “STRUCTURED”
`canvas`	boolean	No	Enable canvas
`extendedThinking`	boolean	No	Enable extended thinking mode

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 (default: true)

Input Fields Configuration

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

Examples

Updating Basic Properties

const axios = require("axios");

async function updateAgentName() {
  const response = await axios.patch(
    "https://api.langdock.com/agent/v1/update",
    {
      agentId: "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("Agent updated:", response.data.message);
}

Validation Rules

The API enforces several validation rules:

Agent access - Your API key must have access to the agent
Workspace match - Agent 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-80 characters
Description - If provided, maximum 500 characters
Instruction - If provided, maximum 40000 characters
Creativity - If provided, must be between 0 and 1

Response Format

Success Response (200 OK)

{
  status: "success";
  message: "Agent updated successfully";
  agent: {
    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;
    extendedThinking: 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;
      emailDomain: string | null;
    }>;
    attachments: string[];
    createdAt: string;
    updatedAt: string;
  };
}

Error Handling

try {
  const response = await axios.patch('https://api.langdock.com/agent/v1/update', ...);
} catch (error) {
  if (error.response) {
    switch (error.response.status) {
      case 400:
        console.error('Invalid parameters or resource not found:', 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 agent');
        break;
      case 404:
        console.error('Agent not found or API key does not have access');
        break;
      case 429:
        console.error('Rate limit exceeded');
        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 agent 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

Langdock intentionally blocks browser-origin requests to protect your API key and ensure your applications remain secure. For more information, please see our guide on API Key Best Practices.

Authorizations

Authorization

string

header

required

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Body

application/json

agentId

string<uuid>

required

name

string

required

Maximum string length: 64

instructions

string

required

Maximum string length: 16384

description

string

Maximum string length: 256

temperature

number

Required range: 0 <= x <= 1

model

string

Maximum string length: 64

capabilities

object

Show child attributes

actions

any[]

vectorDb

any[]

knowledgeFolderIds

string[]

attachmentIds

string<uuid>[]

Array of UUID strings identifying attachments for this message

Response

200

Agent updated successfully

Agent Create API Agent Publish API

⌘I

Documentation Index

​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