Automated Tests

The Automated Tests API contains all methods related to all models used in Automated Tests.

API SUBPATH: eva-automated-tests

This API covers all Models used in Automated Tests: There's the Automated Test itself, which contains it's provided Utterances, and then their executions and results as both an Automated Tests Executions collection and a Utterance Executions collection.

Automated Tests

Once created, an automated test is then listed as an execution which still didn't run. Hence, there is no pagination for Automated Tests.

Creates a new Automated Test

post

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

channelstringRequired

A valid channel Uuid

namestringRequired

A valid name to the test

Body

filestring · binaryRequired

File with data to test

Responses

201

Created

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-tests?channel=text&name=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "message": "text",
  "dataTest": {
    "testId": "text",
    "utterances": [
      {
        "uuid": "text",
        "description": "text",
        "utterance": "text",
        "expectedCategory": "text",
        "expectedValue": "text",
        "expectedAnswer": "text",
        "createdAt": "2025-07-01T01:35:49.662Z",
        "updatedAt": "2025-07-01T01:35:49.662Z"
      }
    ],
    "rows": 1
  }
}

Submits a new file for an existing, unexecuted Automated Test.

post

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

testUUIDstringRequired

A valid automated test execution Uuid

Query parameters

channelstringRequired

A valid channel Uuid

namestringRequired

A valid name to the test

Body

filestring · binaryRequired

File with data to test

Responses

200

Ok

application/json

400

Bad Request

application/json

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

application/json

422

Unprocessable Entity

*/*

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-tests/{testUUID}?channel=text&name=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "message": "text",
  "dataTest": {
    "testId": "text",
    "utterances": [
      {
        "uuid": "text",
        "description": "text",
        "utterance": "text",
        "expectedCategory": "text",
        "expectedValue": "text",
        "expectedAnswer": "text",
        "createdAt": "2025-07-01T01:35:49.662Z",
        "updatedAt": "2025-07-01T01:35:49.662Z"
      }
    ],
    "rows": 1
  }
}

Removes all automated tests from a given channel

delete

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

userUUIDstringRequired

A valid user Uuid

channelUuidstringRequired

A valid channel Uuid

Responses

201

Removed

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

HTTPcURLJavaScriptPython

DELETE /internal/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-tests/remove-all-from-channel?userUUID=text&channelUuid=text HTTP/1.1
Host: 
Accept: */*

{
  "message": "text",
  "dataTest": {
    "testId": "text",
    "utterances": [
      {
        "uuid": "text",
        "description": "text",
        "utterance": "text",
        "expectedCategory": "text",
        "expectedValue": "text",
        "expectedAnswer": "text",
        "createdAt": "2025-07-01T01:35:49.662Z",
        "updatedAt": "2025-07-01T01:35:49.662Z"
      }
    ],
    "rows": 1
  }
}

Automated Test Executions

Acquires a pagination of all Automated Tests.

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

orderBystringOptional

Field want to sort by. Default is 'updatedAt'; other available terms are 'name' and 'score'.

Default: updatedAt

directionstringOptional

Direction of ordenation, ASC or DESC. The default is DESC

Default: DESC

pageinteger · int32Optional

The number of page and the default is 1

Default: 1Example: 1

sizeinteger · int32Optional

The number of services per pages and the default is 5

Default: 5Example: 1

Responses

200

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-execution HTTP/1.1
Host: 
Accept: */*

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "unpaged": true,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "size": 1,
  "content": [
    {
      "id": "text",
      "name": "text",
      "lastUpdated": 1,
      "channelDTO": {
        "channelId": "text",
        "channelName": "text",
        "channelImage": "text",
        "typeChannel": 1
      },
      "result": 1,
      "status": "PENDING"
    }
  ],
  "number": 1,
  "empty": true
}

Acquires a pagination of all Utterances belonguing to a given Automated Test.

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

testUUIDstringRequired

A valid automated test execution Uuid

Query parameters

pageinteger · int32Optional

The number of page and the default is 1

Default: 1Example: 1

sizeinteger · int32Optional

The number of services per pages and the default is 5

Default: 5Example: 1

Responses

200

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-utterances/{testUUID} HTTP/1.1
Host: 
Accept: */*

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "unpaged": true,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "size": 1,
  "content": [
    {
      "uuid": "text",
      "description": "text",
      "utterance": "text",
      "expectedCategory": "text",
      "expectedValue": "text",
      "expectedAnswer": "text",
      "createdAt": "2025-07-01T01:35:49.662Z",
      "updatedAt": "2025-07-01T01:35:49.662Z"
    }
  ],
  "number": 1,
  "empty": true
}

Runs or re-runs an Automated Test.

post

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

testUUIDstringRequired

A valid automated test execution Uuid

Responses

200

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-execution/{testUUID} HTTP/1.1
Host: 
Accept: */*

{
  "testId": "text",
  "status": "PENDING"
}

Retrieves the test assertiveness of a given Automated Test Execution.

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

testUUIDstringRequired

A valid automated test execution Uuid

Responses

200

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-execution/{testUUID}/assertiveness HTTP/1.1
Host: 
Accept: */*

{
  "testId": "text",
  "testName": "text",
  "countOfTests": 1,
  "lastUpdated": 1,
  "status": "PENDING",
  "totalSentences": 1,
  "assertivenessChart": {
    "total": 1,
    "intents": {
      "low": 1,
      "half": 1,
      "high": 1
    },
    "questions": {
      "low": 1,
      "half": 1,
      "high": 1
    },
    "dispersionIntentChart": {
      "low": [
        {
          "confidence": 1,
          "value": "text"
        }
      ],
      "average": [
        {
          "confidence": 1,
          "value": "text"
        }
      ],
      "high": [
        {
          "confidence": 1,
          "value": "text"
        }
      ]
    },
    "dispersionQuestionsChart": {
      "low": [
        {
          "confidence": 1,
          "value": "text"
        }
      ],
      "average": [
        {
          "confidence": 1,
          "value": "text"
        }
      ],
      "high": [
        {
          "confidence": 1,
          "value": "text"
        }
      ]
    }
  }
}

Utterance Executions

Acquires a pagination of all Utterance Execution results belonguing to a given Automated Test Execution.

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

testUUIDstringRequired

A valid bot Uuid

Query parameters

filterstringRequired

LOW, AVERAGE, HIGH or ALL

pageinteger · int32Optional

The number of page and the default is 1

Default: 1Example: 1

sizeinteger · int32Optional

The number of services per pages and the default is 5

Default: 5Example: 1

Responses

200

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-utterance-execution/{testUUID}?filter=text HTTP/1.1
Host: 
Accept: */*

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "unpaged": true,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "size": 1,
  "content": [
    {
      "utterance": "text",
      "successRate": 1,
      "categoryUtterance": {
        "expected": "text",
        "given": "text"
      },
      "answerUtterance": {
        "expected": "text",
        "given": "text"
      },
      "valueUtterance": {
        "expected": "text",
        "given": "text"
      }
    }
  ],
  "number": 1,
  "empty": true
}

Exports all the data of an automated test. In the Cockpit, this is consumed and delivered as a .xls file.

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

testUUIDstringRequired

A valid bot Uuid

Query parameters

filterstringRequired

LOW, AVERAGE, HIGH or ALL

Responses

200

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-utterance-execution/{testUUID}/export?filter=text HTTP/1.1
Host: 
Accept: */*

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "unpaged": true,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "size": 1,
  "content": [
    {
      "utterance": "text",
      "successRate": 1,
      "categoryUtterance": {
        "expected": "text",
        "given": "text"
      },
      "answerUtterance": {
        "expected": "text",
        "given": "text"
      },
      "valueUtterance": {
        "expected": "text",
        "given": "text"
      }
    }
  ],
  "number": 1,
  "empty": true
}