Macros
List all macros
Returns paginated list of macros available to the user. Includes personal macros (created by the user) and global macros (available to the entire account).
GET
/
api
/
v1
/
macros
List all macros
curl --request GET \
--url https://api.evoai.app/api/v1/macros \
--header 'api_access_token: <api-key>'import requests
url = "https://api.evoai.app/api/v1/macros"
headers = {"api_access_token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};
fetch('https://api.evoai.app/api/v1/macros', 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/macros",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.evoai.app/api/v1/macros"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api_access_token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.evoai.app/api/v1/macros")
.header("api_access_token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/macros")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Example Macro",
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"visibility": "personal",
"actions": [
{
"action_name": "send_message",
"action_params": [
"Hello, how can I help you?"
]
}
],
"created_by_id": "660e8400-e29b-41d4-a716-446655440001",
"updated_by_id": "660e8400-e29b-41d4-a716-446655440001",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
],
"meta": {
"pagination": {
"page": 1,
"pageSize": 20,
"total": 1,
"totalPages": 1,
"hasNextPage": null,
"hasPreviousPage": null
},
"timestamp": "2024-01-15T10:30:00Z"
},
"message": "Macros retrieved successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "GET"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "GET"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "Forbidden"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "GET"
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "GET"
}
}Autorizações
Parâmetros de consulta
Page number for pagination
Intervalo obrigatório:
x >= 1Number of macros per page
Intervalo obrigatório:
1 <= x <= 100⌘I
List all macros
curl --request GET \
--url https://api.evoai.app/api/v1/macros \
--header 'api_access_token: <api-key>'import requests
url = "https://api.evoai.app/api/v1/macros"
headers = {"api_access_token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};
fetch('https://api.evoai.app/api/v1/macros', 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/macros",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.evoai.app/api/v1/macros"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api_access_token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.evoai.app/api/v1/macros")
.header("api_access_token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/macros")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Example Macro",
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"visibility": "personal",
"actions": [
{
"action_name": "send_message",
"action_params": [
"Hello, how can I help you?"
]
}
],
"created_by_id": "660e8400-e29b-41d4-a716-446655440001",
"updated_by_id": "660e8400-e29b-41d4-a716-446655440001",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
],
"meta": {
"pagination": {
"page": 1,
"pageSize": 20,
"total": 1,
"totalPages": 1,
"hasNextPage": null,
"hasPreviousPage": null
},
"timestamp": "2024-01-15T10:30:00Z"
},
"message": "Macros retrieved successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "GET"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "GET"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "Forbidden"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "GET"
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "GET"
}
}