Check Assistant Health

Developing

GET

/api/v1/health/{assistantid}

Maintainer:Not configured

Confirms the assistant belongs to the API key's company and is active, sends it the greeting hi, and reports whether a reply came back. HEALTHY with code 00 means a reply was returned; every other outcome is NOT HEALTHY with code 99. Greetings are answered without calling the AI model, so this does not test the model. Limited to 2 calls per minute for each API key across all assistants, and not billed in AI credits.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Check completed. Read responseCode and responseMessage for the result.

Bodyapplication/json

🟠401

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/health/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Reply returned

{
    "responseCode": "00",
    "responseMessage": "HEALTHY",
    "responseData": "Hi there! What can I do for you?"
}

Modified at 2026-11-09 15:56:25

Upload Files With OCR

Pet