Skip to main content
POST
/
external
/
v1
/
ai
/
agent_graph
/
health
Health Check
curl --request POST \
  --url https://api.example.com/external/v1/ai/agent_graph/health \
  --header 'Content-Type: application/json' \
  --data '
{
  "businessId": "<string>",
  "clientKey": "<string>"
}
'
{
  "response.healthy": true
}
Use this endpoint to confirm the Agent Graph API is operational before starting a conversation, or to monitor availability in your infrastructure.

​
Endpoint

POST https://api.connectly.ai/external/v1/ai/agent_graph/health

​
Request body

​
businessId
string
required
Your Connectly business identifier.
​
clientKey
string
required
A client key associated with your business. Does not need to correspond to an active session.

​
Response

​
response.healthy
boolean
true when the Agent Graph API is operational and ready to accept sessions. If false or absent, treat the API as unavailable and retry after a short delay.

​
Example

POST /external/v1/ai/agent_graph/health HTTP/1.1
Host: api.connectly.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json

{ "businessId": "your-business-id", "clientKey": "your-client-key" }

{
  "response": { "healthy": true }
}