Skip to main content
GET
/
v1
/
test-runs
/
{jobId}
Get Test Run
curl --request GET \
  --url https://api.sigmamind.ai/v1/test-runs/{jobId} \
  --header 'X-API-Key: <api-key>'
{
  "batchId": "batch_s0OJu2JWR8R45Fai",
  "workspaceId": "org_V6eZ2zg8ziDx5pft",
  "agent": {
    "name": "Demo Agent",
    "agentId": "mJzLaPEo425lieb9",
    "status": "Testing"
  },
  "testCase": {
    "testCaseId": "tc_d17T6uReChpyfFeP",
    "agent": {
      "name": "Demo Agent",
      "agentId": "mJzLaPEo425lieb9",
      "status": "Testing"
    },
    "workspaceId": "org_V6eZ2zg8ziDx5pft",
    "llmModel": "gpt-4o-mini",
    "mockData": [
      {
        "variableName": "customer_name",
        "value": "John Doe"
      },
      {
        "variableName": "account_status",
        "value": "active"
      }
    ],
    "userPrompt": "You are an angry customer who wants to cancel his subscription. ",
    "attempt": 5,
    "successCriteria": "Agent should acknowledge the request, offer alternatives, and confirm cancellation if the user insists."
  },
  "jobId": "job_ksUu5yRHGTLLrLeM",
  "chatId": "chat-IpELinkFvINQ1212",
  "createdDate": "2023-11-07T05:31:56Z",
  "completedDate": "2023-11-07T05:31:56Z",
  "isSuccesful": true,
  "remarks": "The Agent successfully maintained focus on the primary task of addressing the customer's order enquiry."
}

Authorizations

​
X-API-Key
string
header
required

API Key is required in header. You can find it in the settings

Path Parameters

​
jobId
string
required

A unique identifier for the run.

Query Parameters

​
batchId
string
required

A unique identifier for the batch.

​
agentId
string
required

A unique identifier for the agent to which the batch belongs.

Response

OK

​
batchId
string

Unique identity for a batch

Example:

"batch_s0OJu2JWR8R45Fai"

​
workspaceId
string

Workspace to which the user belongs

Example:

"org_V6eZ2zg8ziDx5pft"

​
agent
object

Assigned agent for current campaign

Example:
{
  "name": "Demo Agent",
  "agentId": "mJzLaPEo425lieb9",
  "status": "Testing"
}
​
testCase
object
​
jobId
string

Unique identity of a test case run

Example:

"job_ksUu5yRHGTLLrLeM"

​
chatId
string

Unique identity of chat id

Example:

"chat-IpELinkFvINQ1212"

​
createdDate
string<date-time>

Timestamp when the batch was created

​
completedDate
string<date-time>

Timestamp when the batch was completed

​
isSuccesful
boolean

Whether the success criteria was met by the agent during the run

Example:

true

​
remarks
string

Reason for the success criteria evaluation

Example:

"The Agent successfully maintained focus on the primary task of addressing the customer's order enquiry."