test_framework

List scenario folders

Changed on

List scenario folders

get/test_framework/v2/scenarios/folders/

Request

  • Base URL
    https://api.cekura.ai
  • URL
    https://api.cekura.ai/test_framework/v2/scenarios/folders/
  • Auth
    • API key in header X-CEKURA-API-KEY
    • or HTTP bearer
    • or HTTP bearer

Query parameters

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

project_idinteger required

Project ID to list folders for

parent_pathstring

Root folder whose subfolders to list. Pass an empty string for root folders only.

searchstring

Search folders by name (case-insensitive)

agent_idinteger

Tenant scope. Supply one of agent_id, project_id, assistant_id when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant.

assistant_idstring

Tenant scope. Supply one of agent_id, project_id, assistant_id when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "https://api.cekura.ai/example/v1/example-external/?page=4",
  "previous": "https://api.cekura.ai/example/v1/example-external/?page=3"
}

Changes