Skip to main content
PATCH
/
api
/
openapi
/
v1
/
bots
/
{id}
Atualizar Bot
curl --request PATCH \
  --url https://app.converza.io/api/openapi/v1/bots/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "role": "support",
  "description": "<string>",
  "instructions": "<string>",
  "temperature": 1,
  "identification_name": "<string>",
  "questions": [
    {
      "question": "<string>",
      "answer": "<string>"
    }
  ],
  "document_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "allow_human": true,
  "actions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "endpoint": "<string>",
      "method": "GET",
      "headers": {},
      "body": [
        {
          "key": "<string>",
          "value": "<string>",
          "type": "string"
        }
      ]
    }
  ],
  "use_audio_responses": true,
  "allow_user_audio_requests": true,
  "capture_payments": true,
  "break_lines": true,
  "chat_model_level": 1
}
'
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Bot de Suporte",
    "role": "support",
    "description": "Lida com consultas de suporte ao cliente",
    "openai_id": "asst_abc123",
    "vector_id": "vs_abc123",
    "instructions": "<string>",
    "temperature": 0.7,
    "published": true,
    "allow_human": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Token JWT obtido do endpoint /api/openapi/auth/token

Path Parameters

id
string<uuid>
required

ID do Bot (UUID)

Example:

"770e8400-e29b-41d4-a716-446655440002"

Body

application/json
name
string
role
enum<string>
Available options:
support,
dynamic,
sales
description
string
instructions
string
temperature
number<float>
Required range: 0 <= x <= 2
identification_name
string | null
questions
object[]
document_ids
string<uuid>[]
allow_human
boolean
actions
object[]
use_audio_responses
boolean
allow_user_audio_requests
boolean
capture_payments
boolean
break_lines
boolean
chat_model_level
integer
Required range: 0 <= x <= 2

Response

Bot atualizado com sucesso

success
boolean
Example:

true

data
object