Create a new assistant programmatically
ASSISTANT_API scope. Created assistants are automatically shared with the API key for use in chat completions.| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the assistant (1-255 characters) |
description | string | No | Description of what the assistant does (max 256 chars) |
emoji | string | No | Emoji icon for the assistant (e.g., ”🤖“) |
instruction | string | No | System prompt/instructions for the assistant (max 16384 chars) |
inputType | string | No | Input type: “PROMPT” or “STRUCTURED” (default: “PROMPT”) |
model | string | No | Model UUID to use (uses workspace default if not provided) |
creativity | number | No | Temperature between 0-1 (default: 0.3) |
conversationStarters | string[] | No | Array of suggested prompts to help users get started |
actions | array | No | Array of action objects for custom integrations |
inputFields | array | No | Array of form field definitions (for STRUCTURED input type) |
attachments | string[] | No | Array of attachment UUIDs to include with the assistant |
webSearch | boolean | No | Enable web search capability (default: false) |
imageGeneration | boolean | No | Enable image generation capability (default: false) |
dataAnalyst | boolean | No | Enable code interpreter capability (default: false) |
canvas | boolean | No | Enable canvas capability (default: false) |
actions array should contain:
actionId (required) - UUID of the action from an enabled integrationrequiresConfirmation (optional) - Whether to require user confirmation before executing (default: false)inputType: "STRUCTURED", you can define form fields in the inputFields array:
| Field | Type | Required | Description |
|---|---|---|---|
slug | string | Yes | Unique identifier for the field |
type | string | Yes | Field type (see supported types below) |
label | string | Yes | Display label for the field |
description | string | No | Help text for the field |
required | boolean | No | Whether the field is required (default: false) |
order | number | Yes | Display order (0-indexed) |
options | string[] | No | Options for SELECT type fields |
fileTypes | string[] | No | Allowed file types for FILE type fields |
TEXT - Single line text inputMULTI_LINE_TEXT - Multi-line text areaNUMBER - Numeric inputCHECKBOX - Boolean checkboxFILE - File uploadSELECT - Dropdown selectionDATE - Date pickerattachments array.
createAssistants permissionASSISTANT (not WORKFLOW or PROJECT)createdBy and workspaceId are automatically set from your API keyAPI key as Bearer token. Format "Bearer YOUR_API_KEY"
Name of the assistant
1 - 255Description of what the assistant does
256Emoji icon for the assistant (e.g., "🤖")
System prompt/instructions for the assistant
16384Input type for the assistant
PROMPT, STRUCTURED Model UUID to use (uses workspace default if not provided)
Temperature for response generation
0 <= x <= 1Array of suggested prompts to help users get started
Array of action objects for custom integrations
Array of form field definitions (for STRUCTURED input type)
Array of attachment UUIDs to include with the assistant
Enable web search capability
Enable image generation capability
Enable code interpreter capability
Enable canvas capability