Skip to main content
POST
/
ai-agents
/
integrations
Create Integration
curl --request POST \
  --url https://{appid}.api-{region}.cometchat.io/v3/ai-agents/integrations \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "id": "<string>",
  "name": "<string>",
  "type": "agent",
  "icon": "<string>",
  "tags": [
    "<string>"
  ],
  "isActive": true,
  "metaData": {}
}
'
{
  "success": true
}

Authorizations

​
apikey
string
header
required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Body

application/json
​
id
string
required
​
name
string
required
​
type
enum<string>
required

Allowed values: agent, llm

Available options:
agent,
llm
​
icon
string
required
​
tags
string[]
required
​
isActive
boolean
default:true
required
​
metaData
object
required

Response

Integration created successfully

​
success
boolean
required

Indicates whether the operation was successful

Example:

true