> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs-parschat.parstechai.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs-parschat.parstechai.com/_mcp/server.

# Get a robot

GET https://api-chat.parstechai.com/v1/robots/{robot_id}

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.

Reference: https://docs-parschat.parstechai.com/api-reference/robots/get-robot

## Authentication

- `Authorization` header (bearer token, required) — Your API key, issued by ParsChat sales. One key per account, spanning every robot you own. Send it as `Authorization: Bearer pk_live_…`.

## Request

### Path parameters

- `robot_id` (string, required) — The robot's id, as returned by the create call.

## Response

### 200

The robot.

- `id` (string, optional) — ParsChat identifier for the robot.
- `name` (string, optional) — Display name, shown in the panel.
- `external_id` (string, optional, nullable) — Your own identifier for this customer. Returned on every webhook event, so you do not need a lookup table. `null` until you set one.
- `description` (string, optional, nullable) — Free text about the robot, up to 255 characters. `null` until you set it.
- `is_active` (boolean, optional) — `false` while the robot is deactivated: its channels are switched off. See `PATCH /robots/{robot_id}`.
- `channels` (list of ChannelSummary, optional) — Channels attached to this robot, in short form. Empty until you connect one. Call the channels endpoint for the full record.
- `created_at` (datetime, optional) — When the robot was created.
- `settings` (RobotSettings, optional) — 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

The request itself is malformed: a parameter is missing, unparseable, or out of range. Unlike 422, the request never reached validation of its contents.

- `error` (ErrorError, optional)

### 401 Unauthorized Error

The key is missing, wrong, revoked, or past its expiry date. All four answer `invalid_key`: telling an expired key from an unknown one would confirm to whoever holds a leaked key that it was once real.

- `error` (ErrorError, optional)

### 403 Forbidden Error

The call is understood but not permitted: a missing role, a lapsed plan, or exhausted capacity.

- `error` (ErrorError, optional)

### 404 Not Found Error

No such resource, or it belongs to another partner. We return 404 rather than 403 here, because a 403 would confirm the id exists.

- `error` (ErrorError, optional)

### 429 Too Many Requests Error

You are calling the API too fast. `details` names the limit you are held to. This never means an automated reply to an end customer was discarded: those are queued, not dropped.

- `error` (ErrorError, optional)

### 500 Internal Server Error

Something failed on our side. Retry with backoff, and quote `request_id` if it persists.

- `error` (ErrorError, optional)

### 503 Service Unavailable Error

A service we depend on (a channel provider, or our AI service) is unavailable. Retry with backoff.

- `error` (ErrorError, optional)

## Types

### ChannelSummary

The short form of a channel, as it appears inside a robot.

- `id` (string, optional) — ParsChat identifier for the channel.
- `type` (enum, optional) — The kind of surface this channel connects.
  - Allowed values: `telegram`, `instagram`, `goftino`, `widget`, `crisp`, `gap`, `whatsapp`
- `is_active` (boolean, optional) — Whether the channel is receiving traffic.

### RobotSettings

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.

- `conversations` (ConversationSettings, required) — How the robot's conversations are run.
- `ai` (AISettings, required, nullable) — `null` without an AI messages package.
- `ai_operator` (AIOperatorSettings, required, nullable) — `null` without an AI messages package.

### ErrorError

- `code` (string, optional) — Stable machine-readable code. Branch on this, not on the message.
- `message` (string, optional) — Human-readable explanation. Wording may change.
- `request_id` (string, optional) — Log this. It is what lets support find your exact request.
- `details` (map from string to any, optional) — Machine-readable context for the code. On `capacity_exhausted` it carries `occupied`, `requested` and `capacity`; on `rate_limited`, `limit_per_minute` and `window_seconds`.

### ConversationSettings

How the robot's conversations are run.

- `auto_close` (AutoCloseSettings, required) — When an idle conversation is closed. A robot that never set it shows the rule actually in force (today, 7 days).
- `operator_handover` (OperatorHandoverSettings, required) — What the customer is told when the AI hands their conversation to a person.
- `offline` (OfflineMessageSettings, required) — What a customer waiting for a person is told while the robot is offline.
- `busy` (BusyMessageSettings, required) — What a customer waiting for a person is told when nobody has replied in time.
- `working_hours` (WorkingHours, required) — When your customer's team is at work. Outside these hours the robot counts as offline, which is what `ai_operator.availability` and the offline message follow.
- `offline_message` (string, required, deprecated) — Deprecated: use `offline.message`. The same text.
- `ai_failure_message` (enum, required, deprecated) — Deprecated and ignored: when the AI cannot answer, the customer gets the operator handover message. Always `null`.
  - Allowed values: `offline_message`, `handover_message`, `none`

### AISettings

How the AI answers. Present only for an account holding an AI messages package.

- `enhanced_accuracy` (boolean, required) — Check every answer before sending it. Uses two AI units per message.
- `creativity` (integer, required) — 0 sticks closely to your customer's content, 100 is freest.
- `language` (enum, required) — `auto` answers in the customer's own language.
  - Allowed values: `auto`, `persian`, `english`, `dutch`
- `topic` (string, required) — What the robot answers about, given to the AI with every question (the panel's robot introduction). Saved at once: nothing is retrained and no characters are used. 5 characters or fewer counts as none.

### AIOperatorSettings

When the AI answers instead of a person. Present only for an account holding an AI messages package.

- `enabled` (boolean, required) — `false`: the AI never answers; every conversation waits for a person.
- `display_name` (string, required) — The AI's name in the operator list. 1 to 50 characters.
- `start_mode` (enum, required) — `on_first_message` answers at once; `if_operator_not_respond` answers only after `wait_minutes` without an operator reply.
  - Allowed values: `on_first_message`, `if_operator_not_respond`
- `availability` (enum, required) — Answer only while the team is online, only while it is offline (outside working hours or with nobody online), or always.
  - Allowed values: `online`, `offline`, `always`
- `wait_minutes` (integer, required) — Minutes to wait for an operator before the AI answers. Used only by `if_operator_not_respond`. 1 to 10080 (one week).

### AutoCloseSettings

When an idle conversation is closed. A robot that never set it shows the rule actually in force (today, 7 days).

- `enabled` (boolean, required) — `true`: a conversation closes after `idle_minutes` without a message. `false`: it closes after `max_idle_minutes` (15 days). Off never means never.
- `idle_minutes` (integer, required) — Minutes without a message before a conversation closes, 15 to 21600. Kept while `enabled` is `false`, so turning it back on restores it.
- `max_idle_minutes` (integer, required) — The ceiling: always 21600 (15 days). Read-only.

### OperatorHandoverSettings

What the customer is told when the AI hands their conversation to a person.

- `message` (string, required) — Sent once per conversation when the AI hands the conversation to a person, on every channel. Up to 500 characters; required while `send_message` is on.
- `send_message` (boolean, required) — Whether `message` is sent.

### OfflineMessageSettings

What a customer waiting for a person is told while the robot is offline.

- `message` (string, required) — Sent once per conversation to a customer waiting for a person while the robot is offline: outside its working hours. Up to 500 characters; required while `send_message` is on.
- `send_message` (boolean, required) — Whether `message` is sent. Off until you switch it on.

### BusyMessageSettings

What a customer waiting for a person is told when nobody has replied in time.

- `message` (string, required) — Sent once per conversation to a customer waiting for a person while the robot is online, when nobody has replied within `after_seconds`. Up to 500 characters; required while `send_message` is on.
- `send_message` (boolean, required) — Whether `message` is sent. Off until you switch it on.
- `after_seconds` (integer, required) — Seconds without a reply before `message` is sent, 30 to 3600.

### WorkingHours

When your customer's team is at work. Outside these hours the robot counts as offline, which is what `ai_operator.availability` and the offline message follow.

- `enabled` (boolean, required) — `false`: every hour is a working hour.
- `time_zone` (string, required) — An IANA time zone.
- `days` (WorkingHoursDays, required) — Each day's open windows, `SAT` to `FRI`. `[]` means closed that day.

### WorkingHoursDays

Each day's open windows, `SAT` to `FRI`. `[]` means closed that day.

- `SAT` (list of WorkingHoursWindow, optional)
- `SUN` (list of WorkingHoursWindow, optional)
- `MON` (list of WorkingHoursWindow, optional)
- `TUE` (list of WorkingHoursWindow, optional)
- `WED` (list of WorkingHoursWindow, optional)
- `THU` (list of WorkingHoursWindow, optional)
- `FRI` (list of WorkingHoursWindow, optional)

### WorkingHoursWindow

One open interval, local to the schedule's `time_zone`. `HH:MM`, 24-hour, `start` before `end`.

- `start` (string, required) — `HH:MM`.
- `end` (string, required) — `HH:MM`, after `start`.

## Examples

### One robot

**Response**

```json
{
  "id": "rbt_8fK2mQ",
  "name": "Rose Flower Shop",
  "external_id": "shop_10422",
  "description": null,
  "is_active": true,
  "channels": [
    {
      "id": "chn_3pQ7xL",
      "type": "instagram",
      "is_active": true
    }
  ],
  "created_at": "2026-09-20T11:04:33Z",
  "settings": {
    "conversations": {
      "auto_close": {
        "enabled": true,
        "idle_minutes": 360,
        "max_idle_minutes": 21600
      },
      "operator_handover": {
        "message": "An operator will join you shortly.",
        "send_message": true
      },
      "offline": {
        "message": "در حال حاضر اپراتورهای ما آنلاین نیستند. پیام شما ثبت شد و به‌محض آنلاین شدن اولین اپراتور پاسخ داده می‌شود.",
        "send_message": false
      },
      "busy": {
        "message": "در حال حاضر اپراتورهای ما مشغول هستند. پیام شما ثبت شد و در اولین فرصت پاسخ داده می‌شود.",
        "send_message": false,
        "after_seconds": 300
      },
      "working_hours": {
        "enabled": true,
        "time_zone": "Asia/Tehran",
        "days": {
          "SAT": [
            {
              "start": "09:00",
              "end": "18:00"
            }
          ],
          "SUN": [
            {
              "start": "09:00",
              "end": "13:00"
            },
            {
              "start": "16:00",
              "end": "20:00"
            }
          ],
          "MON": [
            {
              "start": "09:00",
              "end": "18:00"
            }
          ],
          "TUE": [
            {
              "start": "09:00",
              "end": "18:00"
            }
          ],
          "WED": [
            {
              "start": "09:00",
              "end": "18:00"
            }
          ],
          "THU": [
            {
              "start": "09:00",
              "end": "13:00"
            }
          ],
          "FRI": []
        }
      },
      "offline_message": "در حال حاضر اپراتورهای ما آنلاین نیستند. پیام شما ثبت شد و به‌محض آنلاین شدن اولین اپراتور پاسخ داده می‌شود.",
      "ai_failure_message": null
    },
    "ai": {
      "enhanced_accuracy": false,
      "creativity": 50,
      "language": "auto",
      "topic": "Flower shop: roses and tulips, delivery inside Tehran only"
    },
    "ai_operator": {
      "enabled": true,
      "display_name": "Rose assistant",
      "start_mode": "on_first_message",
      "availability": "always",
      "wait_minutes": 3
    }
  }
}
```

**SDK Code**

```python One robot
import requests

url = "https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript One robot
const url = 'https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go One robot
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby One robot
require 'uri'
require 'net/http'

url = URI("https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java One robot
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php One robot
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp One robot
using RestSharp;

var client = new RestClient("https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift One robot
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Account without an AI package, nothing changed yet

**Response**

```json
{
  "id": "rbt_2wN5tR",
  "name": "Tulip Corner",
  "external_id": null,
  "description": null,
  "is_active": true,
  "channels": [],
  "created_at": "2026-10-20T08:00:00Z",
  "settings": {
    "conversations": {
      "auto_close": {
        "enabled": true,
        "idle_minutes": 10080,
        "max_idle_minutes": 21600
      },
      "operator_handover": {
        "message": "",
        "send_message": false
      },
      "offline": {
        "message": "در حال حاضر اپراتورهای ما آنلاین نیستند. پیام شما ثبت شد و به‌محض آنلاین شدن اولین اپراتور پاسخ داده می‌شود.",
        "send_message": false
      },
      "busy": {
        "message": "در حال حاضر اپراتورهای ما مشغول هستند. پیام شما ثبت شد و در اولین فرصت پاسخ داده می‌شود.",
        "send_message": false,
        "after_seconds": 300
      },
      "working_hours": {
        "enabled": false,
        "time_zone": "UTC",
        "days": {
          "SAT": [],
          "SUN": [],
          "MON": [],
          "TUE": [],
          "WED": [],
          "THU": [],
          "FRI": []
        }
      },
      "offline_message": "در حال حاضر اپراتورهای ما آنلاین نیستند. پیام شما ثبت شد و به‌محض آنلاین شدن اولین اپراتور پاسخ داده می‌شود.",
      "ai_failure_message": null
    },
    "ai": {
      "enhanced_accuracy": false,
      "creativity": 50,
      "language": "auto",
      "topic": "Flower shop: roses and tulips, delivery inside Tehran only"
    },
    "ai_operator": {
      "enabled": true,
      "display_name": "Rose assistant",
      "start_mode": "on_first_message",
      "availability": "always",
      "wait_minutes": 3
    }
  }
}
```

**SDK Code**

```python Account without an AI package, nothing changed yet
import requests

url = "https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Account without an AI package, nothing changed yet
const url = 'https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Account without an AI package, nothing changed yet
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Account without an AI package, nothing changed yet
require 'uri'
require 'net/http'

url = URI("https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Account without an AI package, nothing changed yet
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Account without an AI package, nothing changed yet
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Account without an AI package, nothing changed yet
using RestSharp;

var client = new RestClient("https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Account without an AI package, nothing changed yet
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```