logo
Index
API Reference
Authentication
Manage agents
Get List of agents
Get Agent Presentation
Manage conversations
List Conversations
List Messages
Create conversation ID
Update conversation metadata
Chat with stream
Chat without stream
Send Feedback
Send Survey
Manage datasets
List Dataset
Manage datasets records
Create record
List Records
Delete Record
Manage datasets files
File Upload Dataset
List Files
Delete File
Manage skillsets abilities
Create Ability
powered by zuplo
Sign in

EvaGPT-api

BASE URL
https://api.evagpt.com.br

Authentication

Sign into view and manage your API credentials

Manage agents

List of APIs that manage the Agent.

ENDPOINTS
GET/bot
GET/bot/presentation/:botId

Manage conversations

List of APIs that manage Agent conversations.

ENDPOINTS
GET/conversation
GET/conversation/message/:idConversation
POST/conversation/create/:botId
PUT/conversation/update/:convId
POST/conversation/stream/:idConversation
POST/conversation/complete/:idConversation
POST/conversation/message/feedback/:idmessage
POST/conversation/survey/:idconv

Manage datasets

List of APIs that manage Agent dataset.

ENDPOINTS
GET/dataset

Manage datasets records

List of APIs that manage Agent dataset records.

ENDPOINTS
POST/dataset/record/:datasetid
GET/dataset/record/:datasetid/list
DELETE/dataset/record/:datasetid/:recordid

Manage datasets files

List of APIs that manage Agent dataset files.

ENDPOINTS
POST/dataset/file/:datasetid
GET/dataset/file/:datasetid
DELETE/dataset/file/:fileid

Manage skillsets abilities

List of APIs that manage Agent skillsets abilities.

ENDPOINTS
POST/bot/ability/:botId

Get List of agents

Returns a list of all created agents.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

GET
/bot
1

Get Agent Presentation

Returns the agent's presentation message.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

botId

required, string

Agent ID.

GET
/bot/presentation/:botId
1

List Conversations

List all conversations across all agents.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

GET
/conversation
1

List Messages

List all messages in a conversation.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

idConversation

required, string

ID Conversation

GET
/conversation/message/:idConversation
1

Create conversation ID

Create a new conversation.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

botId

required, string

Agent ID.

Request Body

Payload to create a meta tags.

meta

optional, object
POST
/conversation/create/:botId
1
EXAMPLE BODY
{
  "meta": {}
}

Update conversation metadata

Update conversation metadata.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

convId

required, string

Conversation ID.

Request Body

Payload to create a meta tags.

Unnamed Property

object
PUT
/conversation/update/:convId
1
EXAMPLE BODY
{}

Chat with stream

Immediately return each generated block (token) of the response from the agent.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Content-Type

required, string

Content type of the request body. Use application/json

Path Parameters

idConversation

required, string

Conversation ID.

Request Body

Payload required to chat with an agent.

text

required, string
POST
/conversation/stream/:idConversation
1
EXAMPLE BODY
{
  "text": "Hello, can you help me?"
}

Chat without stream

Returns the response generated by the agent, only when it is complete.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Content-Type

required, string

Content type of the request body. Use application/json

Path Parameters

idConversation

required, string

Conversation ID.

Request Body

Payload required to chat with an agent.

text

required, string
POST
/conversation/complete/:idConversation
1
EXAMPLE BODY
{
  "text": "Lorem"
}

Send Feedback

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

idmessage

required, string

ID gerado por cada interação do agente

Request Body

0 Negativo, 1 Positivo e 2 Neutro

feedback

required, number
POST
/conversation/message/feedback/:idmessage
1
EXAMPLE BODY
{
  "feedback": 1
}

Send Survey

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

idconv

required, string

ID da conversa

Request Body

1 Muito Ruim, 2 Ruim, 3 Neutro, 4 Bom, 5 Muito Bom

nota

required, number
POST
/conversation/survey/:idconv
1
EXAMPLE BODY
{
  "nota": 5
}

List Dataset

Returns the list of datasets

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

GET
/dataset
1

Create record

Create a new record in the selected dataset.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

datasetid

required, string

Dataset ID.

Request Body

Payload required to create a record.

name

required, string

topic

required, string

text

required, string
POST
/dataset/record/:datasetid
1
EXAMPLE BODY
{
  "name": "sunt",
  "topic": "labore",
  "text": "velit in est nulla fugiat"
}

List Records

List all records available in the selected dataset.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

datasetid

required, string

Dataset ID.

GET
/dataset/record/:datasetid/list
1

Delete Record

Delete a specific record from the dataset.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

datasetid

required, string

Dataset ID.

recordid

required, string

Record ID.

DELETE
/dataset/record/:datasetid/:recordid
1

File Upload Dataset

Create multiple records using the data from a file.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

datasetid

required, string

Dataset ID.

Request Body

the following fields are of type 'multipart/form-data'

name

required, string

description

required, string

file

required, string
POST
/dataset/file/:datasetid
1

List Files

List all files in the selected dataset.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

datasetid

required, string

Dataset ID.

GET
/dataset/file/:datasetid
1

Delete File

Delete the selected file and all records linked to it.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

fileid

required, string

File ID.

DELETE
/dataset/file/:fileid
1

Create Ability

Create abilities that allow the agent to interact with other systems through a REST API.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

botid

required, string

Bot ID.

Request Body

Payload required to create an ability. For more information on how to create a new ability, visit the EVAGPT Documentation

name

required, string

description

required, string

instruction

required, string

meta

optional, object
POST
/bot/ability/:botId
1
EXAMPLE BODY
{
  "name": "Previsão do tempo",
  "description": "Use this ability when the user asks about weather forecast. ",
  "instruction": "To get the weather forecast you need to perform the following request:\n\n```fetch\nGET https://wttr.in/{location}?format=4 HTTP/1.1\nUser-Agent: curl/7.61.1\n```\nThe {location} parameter could be any city. For example:\n\n```fetch\nGET https://wttr.in/London?format=4 HTTP/1.1\nUser-Agent: curl/7.61.1\n```",
  "meta": {}
}