test_framework

List the mock tools in a project

Changed on

Return the project's mock tools with their input/output pairs and the agents using each one. Scope with project_id for the whole catalogue, or with agent_id to get only the tools that agent could newly adopt (its own are excluded). search matches the tool name, with or without the c_ prefix. Results are paginated, most-shared first.

get/test_framework/v1/tools/

Request

  • Base URL
    https://api.cekura.ai
  • URL
    https://api.cekura.ai/test_framework/v1/tools/
  • 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.

searchstring

Filter by tool name; matches with or without the c_ prefix.

project_idinteger

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

agent_idinteger

Tenant scope. Supply one of project_id, agent_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