Skip to navigation
API ReferenceRobots

Create a robot

Creates the workspace that holds one customer’s conversations, automation rules and training data. Create the robot before connecting any channel to it.

Put your own customer id in external_id and we return it on every webhook event, so you never need a lookup table between our ids and yours.

Each robot consumes one unit of your plan’s capacity. Deleting one frees that capacity immediately.

settings is optional and takes the same shape as PATCH /robots/{robot_id}; anything you leave out takes its default.

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_….

Request

This endpoint expects an object.
namestringRequired

Display name, shown in the panel. Unique across your robots; reusing one returns 409.

external_idstringOptional

Your own customer id. Unique across your robots; reusing one returns 409.

descriptionstringOptional
Free text about the robot, up to 255 characters.
settingsobjectOptional

Settings to start with, in the same shape as PATCH /robots/{robot_id}. Anything you leave out takes its default.

Response

The robot was created.
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
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error