Skip to main content
GET
/
api
/
openapi
/
v1
/
bots
/
{id}
Obter Bot
curl --request GET \
  --url http://localhost:3000/api/openapi/v1/bots/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "http://localhost:3000/api/openapi/v1/bots/{id}"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:3000/api/openapi/v1/bots/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/openapi/v1/bots/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "http://localhost:3000/api/openapi/v1/bots/{id}"

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(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:3000/api/openapi/v1/bots/{id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/openapi/v1/bots/{id}")

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

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

response = http.request(request)
puts response.read_body
{
  "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>",
        "headers": {
          "key": "<string>",
          "value": "<string>"
        },
        "body": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "documents": [
      {
        "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ]
  }
}
{
"success": false,
"error": "Recurso não encontrado",
"code": "NOT_FOUND"
}

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