Skip to main content
GET
/
api
/
openapi
/
v1
/
bots
/
{id}
Obter Bot
curl --request GET \
  --url https://app.converza.io/api/openapi/v1/bots/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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",
    "questions": [
      {
        "question": "<string>",
        "answer": "<string>"
      }
    ],
    "actions": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "endpoint": "<string>",
        "method": "GET",
        "headers": {
          "key": "<string>",
          "value": "<string>"
        },
        "body": [
          {
            "key": "<string>",
            "value": "<string>",
            "type": "string"
          }
        ]
      }
    ],
    "documents": [
      {
        "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ]
  }
}

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"

Response

Bot recuperado com sucesso

success
boolean
Example:

true

data
object