Skip to navigation

Get a robot

Returns one robot, in the same shape as a list entry.

settings holds the robot’s settings, the same ones your customer sees in the panel. A robot that never changed one shows the value actually in force. settings.ai and settings.ai_operator are null for an account without an AI messages package.

Authentication

AuthorizationBearer

Your API key, issued by ParsChat sales. One key per account, spanning every robot you own. Send it as Authorization: Bearer pk_live_….

Path parameters

robot_idstringRequired
The robot's id, as returned by the create call.

Response

The robot.
idstringOptional
ParsChat identifier for the robot.
namestringOptional
Display name, shown in the panel.
external_idstring or nullOptional

Your own identifier for this customer. Returned on every webhook event, so you do not need a lookup table. null until you set one.

descriptionstring or nullOptional

Free text about the robot, up to 255 characters. null until you set it.

is_activebooleanOptional

false while the robot is deactivated: its channels are switched off. See PATCH /robots/{robot_id}.

channelslist of objectsOptional
Channels attached to this robot, in short form. Empty until you connect one. Call the channels endpoint for the full record.
created_atdatetimeOptional
When the robot was created.
settingsobjectOptional

A robot’s settings, the same ones your customer sees in the ParsChat panel. ai and ai_operator are null for an account without an AI messages package.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error