Sessions
Create New Session
Create a new session for a specific agent and user. Returns a unique session_id that can be used for subsequent chat interactions. Optionally accepts metadata (name, description, tags) for the session.
Supports both authenticated users (via bearer token) and agent bots (via API key). For agent bots, session_id and user_id can be provided in the request body.
POST
/
api
/
v1
/
sessions
/
{agent_id}
Create New Session
curl --request POST \
--url https://api.evoai.app/api/v1/sessions/{agent_id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"request_data": "<unknown>",
"metadata": "<unknown>"
}
'import requests
url = "https://api.evoai.app/api/v1/sessions/{agent_id}"
payload = {
"request_data": "<unknown>",
"metadata": "<unknown>"
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({request_data: '<unknown>', metadata: '<unknown>'})
};
fetch('https://api.evoai.app/api/v1/sessions/{agent_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_URL => "https://api.evoai.app/api/v1/sessions/{agent_id}",
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([
'request_data' => '<unknown>',
'metadata' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <api-key>"
],
]);
$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.evoai.app/api/v1/sessions/{agent_id}"
payload := strings.NewReader("{\n \"request_data\": \"<unknown>\",\n \"metadata\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_access_token", "<api-key>")
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.evoai.app/api/v1/sessions/{agent_id}")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"request_data\": \"<unknown>\",\n \"metadata\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/sessions/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"request_data\": \"<unknown>\",\n \"metadata\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"data": "<unknown>",
"meta": "<unknown>",
"success": true,
"message": "<string>"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid input data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/sessions/{agent_id}",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing authentication token"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/sessions/{agent_id}",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "Insufficient permissions to perform this action"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/sessions/{agent_id}",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Agent not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/sessions/{agent_id}",
"method": "POST"
}
}{
"detail": [
"<unknown>"
]
}{
"success": false,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/sessions/{agent_id}",
"method": "POST"
}
}Autorizações
API Access Token (UUID) for authentication
Cabeçalhos
Parâmetros de caminho
⌘I
Create New Session
curl --request POST \
--url https://api.evoai.app/api/v1/sessions/{agent_id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"request_data": "<unknown>",
"metadata": "<unknown>"
}
'import requests
url = "https://api.evoai.app/api/v1/sessions/{agent_id}"
payload = {
"request_data": "<unknown>",
"metadata": "<unknown>"
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({request_data: '<unknown>', metadata: '<unknown>'})
};
fetch('https://api.evoai.app/api/v1/sessions/{agent_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_URL => "https://api.evoai.app/api/v1/sessions/{agent_id}",
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([
'request_data' => '<unknown>',
'metadata' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <api-key>"
],
]);
$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.evoai.app/api/v1/sessions/{agent_id}"
payload := strings.NewReader("{\n \"request_data\": \"<unknown>\",\n \"metadata\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_access_token", "<api-key>")
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.evoai.app/api/v1/sessions/{agent_id}")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"request_data\": \"<unknown>\",\n \"metadata\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/sessions/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"request_data\": \"<unknown>\",\n \"metadata\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"data": "<unknown>",
"meta": "<unknown>",
"success": true,
"message": "<string>"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid input data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/sessions/{agent_id}",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing authentication token"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/sessions/{agent_id}",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "Insufficient permissions to perform this action"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/sessions/{agent_id}",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Agent not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/sessions/{agent_id}",
"method": "POST"
}
}{
"detail": [
"<unknown>"
]
}{
"success": false,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/sessions/{agent_id}",
"method": "POST"
}
}