Pular para o conteúdo principal
POST
/
agents
Criar assistente
curl --request POST \
  --url https://api.meuassistente.rdstationmentoria.com.br/rest/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": null,
  "purpose": "leads",
  "kbs": [],
  "fields": [],
  "avatar": null,
  "color": "#ff5722",
  "status": "draft",
  "destinations": [],
  "behavior": {
    "answerLength": "short",
    "personality": "personal",
    "engagement": "active"
  },
  "behavior_type": "basic",
  "left": false
}
'
import requests

url = "https://api.meuassistente.rdstationmentoria.com.br/rest/agents"

payload = {
"name": "<string>",
"description": None,
"purpose": "leads",
"kbs": [],
"fields": [],
"avatar": None,
"color": "#ff5722",
"status": "draft",
"destinations": [],
"behavior": {
"answerLength": "short",
"personality": "personal",
"engagement": "active"
},
"behavior_type": "basic",
"left": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: null,
purpose: 'leads',
kbs: [],
fields: [],
avatar: null,
color: '#ff5722',
status: 'draft',
destinations: [],
behavior: {answerLength: 'short', personality: 'personal', engagement: 'active'},
behavior_type: 'basic',
left: false
})
};

fetch('https://api.meuassistente.rdstationmentoria.com.br/rest/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.meuassistente.rdstationmentoria.com.br/rest/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => null,
'purpose' => 'leads',
'kbs' => [

],
'fields' => [

],
'avatar' => null,
'color' => '#ff5722',
'status' => 'draft',
'destinations' => [

],
'behavior' => [
'answerLength' => 'short',
'personality' => 'personal',
'engagement' => 'active'
],
'behavior_type' => 'basic',
'left' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://api.meuassistente.rdstationmentoria.com.br/rest/agents"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": null,\n \"purpose\": \"leads\",\n \"kbs\": [],\n \"fields\": [],\n \"avatar\": null,\n \"color\": \"#ff5722\",\n \"status\": \"draft\",\n \"destinations\": [],\n \"behavior\": {\n \"answerLength\": \"short\",\n \"personality\": \"personal\",\n \"engagement\": \"active\"\n },\n \"behavior_type\": \"basic\",\n \"left\": false\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.meuassistente.rdstationmentoria.com.br/rest/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": null,\n \"purpose\": \"leads\",\n \"kbs\": [],\n \"fields\": [],\n \"avatar\": null,\n \"color\": \"#ff5722\",\n \"status\": \"draft\",\n \"destinations\": [],\n \"behavior\": {\n \"answerLength\": \"short\",\n \"personality\": \"personal\",\n \"engagement\": \"active\"\n },\n \"behavior_type\": \"basic\",\n \"left\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.meuassistente.rdstationmentoria.com.br/rest/agents")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": null,\n \"purpose\": \"leads\",\n \"kbs\": [],\n \"fields\": [],\n \"avatar\": null,\n \"color\": \"#ff5722\",\n \"status\": \"draft\",\n \"destinations\": [],\n \"behavior\": {\n \"answerLength\": \"short\",\n \"personality\": \"personal\",\n \"engagement\": \"active\"\n },\n \"behavior_type\": \"basic\",\n \"left\": false\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "name": "<string>",
  "workspaceId": "<string>",
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "description": null,
  "avatar": null,
  "color": "#ff5722",
  "welcome": null,
  "instructions": null,
  "off": null,
  "references": false,
  "purpose": "leads",
  "freedom": "restricted",
  "behavior_type": "basic",
  "status": "draft",
  "left": false,
  "createdAt": "2026-02-08T00:20:48.487Z",
  "updatedAt": "2026-02-08T00:20:48.487Z"
}
{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corpo

application/json
name
string
obrigatório

Nome do assistente

description
string | null

Instruções ao modelo de IA para direcionar a geração de respostas desejadas

purpose
enum<string>
padrão:leads

Finalidade do assistente

Opções disponíveis:
general,
leads,
cs
kbs
string[]

Bases de conhecimento associadas ao assistente

Identificador único da base de conhecimento

fields
object[]

Campos do assistente

avatar
object | null

Avatar do assistente

color
string
padrão:#ff5722

Cor associada ao assistente

Pattern: ^#[0-9a-fA-F]{6}$
status
enum<string>
padrão:draft

Status do assistente

Opções disponíveis:
online,
offline,
draft
destinations
object[]

Destinos associados ao agente

behavior
object | null

Comportamento configurável do assistente

behavior_type
enum<string>
padrão:basic

Configuração de comportamento do assistente

Opções disponíveis:
basic,
custom
left
boolean
padrão:false

Posição do widget do assistente à esquerda da tela

Resposta

Successful response

id
string
obrigatório

Identificador do assistente

name
string
obrigatório

Nome do assistente

workspaceId
string
obrigatório

Identificador do workspace associado

createdBy
string | null
obrigatório

ID do usuário que criou o registro

updatedBy
string | null
obrigatório

ID do usuário que atualizou o registro

description
string | null

Instruções ao modelo de IA para direcionar a geração de respostas desejadas

avatar
object | null

Avatar do assistente

color
string
padrão:#ff5722

Cor associada ao assistente

Pattern: ^#[0-9a-fA-F]{6}$
welcome
string | null

Mensagem de boas-vindas do assistente

instructions
string | null

Instruções para o assistente

off
string | null

Mensagem quando o assistente não souber a resposta

references
boolean
padrão:false

Indica se o assistente usa referências

purpose
enum<string>
padrão:leads

Finalidade do assistente

Opções disponíveis:
general,
leads,
cs
freedom
enum<string>
padrão:restricted

Uso da base de conhecimento

Opções disponíveis:
free,
restricted
behavior_type
enum<string>
padrão:basic

Configuração de comportamento do assistente

Opções disponíveis:
basic,
custom
status
enum<string>
padrão:draft

Status do assistente

Opções disponíveis:
online,
offline,
draft
left
boolean
padrão:false

Posição do widget do assistente à esquerda da tela

createdAt
string<date-time>
padrão:2026-02-08T00:20:48.487Z

Data de criação

updatedAt
string<date-time>
padrão:2026-02-08T00:20:48.487Z

Data da última atualização