1. AI Agent
  • Getting Started
    • Introduction
    • Quickstart
    • Authentication
    • Status codes
  • Webhook
    • Webhook Setup
    • Webhook Events and Schema
  • SDKs
    • @klink.cloud/call-sdk
  • API Reference
    • Contact
      • Listing
      • Create
      • Filter By SocialPlatformId
      • Form Fields
      • Detail
      • Update
      • Delete
      • Fetch Contact Groups
      • Update tags
      • Filter By Phone Number
    • Tag
      • Listing
    • Channel
      • Listing
      • Create
    • Ticket
      • Listing
      • Create
      • Filter by Contact ID
      • Form Fields
      • Update
      • Update status
    • Category
      • Listing
    • CxLog
      • Listing
      • Get the live transcript
    • Message
      • Send message
      • Create comments
      • Get Comments
      • List WhatsApp templates
    • Media Manager
      • Upload File (multipart)
      • Get Folders
      • Get Folder By ID
      • Create Folder
      • Update Folder
      • Delete Folder
      • Get Files
      • Get File By ID
      • Create File
      • Update File
      • Delete File
    • Agent Activity
      • Get Agents Activities
    • Telephony
      • Get Telephony CDR
    • User
      • Create
      • Listing
      • Detail
      • Update
      • Delete
    • Automation Queue
      • Create
      • Listing
      • Detail
      • Update
      • Delete
      • Add Member
      • Remove Member
    • Role
      • Listing
    • Webchat Identity Verification
      • Get identity verification settings
      • Update identity verification settings
      • Create or rotate the identity secret
    • AI Agent
      • List Models
        GET
      • Listing
        GET
      • Detail
        GET
      • Create
        POST
      • Update
        PATCH
      • Delete
        DELETE
      • Get Flow
        GET
      • List Versions
        GET
      • Update Flow
        PUT
      • Publish
        POST
    • Schemas
      • RequestId
      • CxLogTranscriptResponse
      • IdentityVerificationStatus
      • CxLogTranscript
      • IdentityVerificationUpdate
      • Error
      • IdentityVerificationSettings
      • ValidationError
      • IdentitySecret
      • userToken (JWT claims)
Blog
Github
  1. AI Agent

Create

POST
/api/v1/ai-agents
Creates an AI agent with no flow. Next, save a flow with Update Flow and publish it with Publish.
A new agent does not answer any channel by itself. A workflow rule in the dashboard (Automation → Workflows, action Assign AI Agent) decides which conversations it handles.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢201Success
application/json
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠429Too Many Requests
🔴502Bad Gateway
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://apigw.klinkcx.com/api/v1/ai-agents' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Sales Assistant",
    "inactivityTimeout": 180
}'
Response Response Example
201 - Example 1
{
    "requestId": "string",
    "data": {
        "id": "string",
        "name": "string",
        "inactivityTimeout": 0,
        "hasDraft": true,
        "hasLive": true
    }
}
Modified at 2026-10-23 02:08:30
Previous
Detail
Next
Update
Built with