agents

post/api/v1/agents

Request

  • Base URL: https://api.clerkchat.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.clerkchat.co/api/v1/agents
  • Auth: none required

Request body

namestring required
slugstring required
role'Customer support' | 'Sales agent' | 'Shopping assistant' required
instructionsstring required
welcomeMessagestring nullable

Response

Agent

idstring required
organizationIdstring required
namestring required
slugstring required
role'Customer support' | 'Sales agent' | 'Shopping assistant' required
instructionsstring required
translationLanguage'Adaptive' | 'English' | 'Chinese' | 'Hindi' | 'Spanish' | 'French' | 'Arabic' | 'Bangla' | 'Portuguese' | 'Indonesian' | 'Japanese' | 'Swahili' | 'German' | 'Korean' | 'Italian' | 'Yoruba' | 'Burmese' required
welcomeMessagestring nullable required
avatarUrlstring nullable required
playgroundModelId'deepseek/deepseek-v4-pro-0813' | 'deepseek/deepseek-v4.1-flash' | 'deepseek/deepseek-v4.1-flash-fast' | 'openai/gpt-5.6-luna' required
publicTemplateEnabledboolean required
status'draft' | 'active' | 'archived' required
createdByUserIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.