Assistant Create API
Create a new Assistant programmatically
AGENT_API scope. Created Assistants are automatically shared with the API key for use in chat completions.Request Parameters
Actions Configuration
Each action in theactions array should contain:
actionId(required) - UUID of the action from an enabled integrationrequiresConfirmation(optional) - Whether to require user confirmation before executing (default: true)
Input Fields Configuration
When usinginputType: "STRUCTURED", you can define form fields in the inputFields array:
TEXT- Single line text inputMULTI_LINE_TEXT- Multi-line text areaNUMBER- Numeric inputCHECKBOX- Boolean checkboxFILE- File uploadSELECT- Dropdown selectionMULTI_SELECT- Multi-selectDATE- Date pickerEMAIL- Email address
Obtaining Attachment IDs
To include attachments with your Assistant, first upload files using the Upload Attachment API. This will return attachment UUIDs that you can include in theattachments array.
Examples
Creating a Basic Assistant
Validation Rules
The API enforces several validation rules:- Model - Must be in your workspace’s active models list
- Actions - Must belong to integrations enabled in your workspace
- Attachments - Must exist in your workspace and not be deleted
- Folders - Must exist in your workspace and not be deleted
- Permissions - Your API key must have the
createAssistantspermission - Name - Must be between 1-80 characters
- Description - Maximum 800 characters
- Instruction - Maximum 50000 characters
- Creativity - Must be between 0 and 1
Important Notes
- Created Assistants are automatically shared with your API key for use in chat completions
- The API key creator becomes the owner and can manage the Assistant in the UI
- Attachments are bidirectionally linked to the Assistant
createdByandworkspaceIdare automatically set from your API key
Response Format
Success Response (201 Created)
Error Handling
Migrating to Agents API
The new Agents API offers improved compatibility with modern AI SDKs. The create endpoint has similar functionality with updated parameter names. See the equivalent endpoint in the Agents API:- Agent Create API - Uses
agentIdinstead ofassistantId
Authorizations
API key as Bearer token. Format "Bearer YOUR_API_KEY"
Body
Name of the agent
1 - 80Description of what the agent does
800Emoji icon for the agent (e.g., "🤖")
16System prompt/instructions for the agent
50000Input type for the agent
PROMPT, STRUCTURED, INTEGRATION, SCHEDULED, WEBHOOK Model ID to use (see Models for Agent API)
Temperature for response generation
0 <= x <= 1Array of suggested prompts to help users get started
201 - 255Array of action objects for custom integrations
Array of form field definitions (for STRUCTURED input type)
Array of attachment UUIDs to include with the agent
50Array of Folder UUIDs to include with the agent
Enable web search capability
Enable image generation capability
Deprecated. Accepted for compatibility and ignored.
Enable extended thinking