Skip to main content
List Test Cases For A Given Agent
curl --request GET \
  --url https://{api_endpoint}/api/v1/orchestrate/agent/{agent_id}/test_case \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "page": 123,
  "page_size": 123,
  "test_cases": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prompt": "<string>",
      "created_date": "2023-11-07T05:31:56Z",
      "executed_date": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.watson-orchestrate.ibm.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
agent_id
string<uuid>
required

Query Parameters

​
query
string
default:""

Search prompt

​
limit
integer
default:5

Limit the number of results returned

Required range: x >= 1
​
offset
integer
default:0

Skip the first N results

Required range: x >= 0
​
sortkey
enum<string>
default:created_date

Sort key

Available options:
created_date,
executed_date,
prompt
​
sort
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Response

Successful Response

​
total
integer
required

Total number of test cases

​
page
integer
required

Current page

​
page_size
integer
required

Number of results per page

​
test_cases
TestCaseResponse · object[]
required

List of test cases in this page