Skip to main content
GET
Permission Required: project:view-configs
Retrieve a paginated list of agent configurations for your project. Use this endpoint to discover valid agent_config_id values for Start a Run and Start Test Plan Run.

Query Parameters

page
integer
default:"0"
Page number (0-indexed)
page_size
integer
default:"25"
Results per page (1-100)

Response

data
AgentConfig[]
required
Array of agent config objects
pagination
object
required
Pagination metadata (page, page_size, total_count, total_pages)

AgentConfig Object

id
string
required
Agent config ID (use this as agent_config_id when starting runs)
name
string
required
Agent config name
description
string
Optional description
pinned
boolean
required
Whether the config is pinned (pinned items are returned first)

Authorizations

X-Api-Key
string
header
required

API key for authentication

Path Parameters

projectId
string
required

The project ID. You can copy it from the project settings page or the project URL in the dashboard.

Query Parameters

page
integer
default:0

Page number (0-indexed)

page_size
integer
default:25

Results per page (1-100)

Required range: 1 <= x <= 100

Response

Successful response

data
object[]
pagination
object