Skip to main content
GET
List agents a runtime target can use

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project slug, UUID, or domain that identifies the project.

Query Parameters

runtime_target_kind
enum<string>
default:main_branch

Runtime target to inspect. Environment targets require target_environment_id; preview_branch targets require target_branch_id. Missing or mismatched IDs return 400.

Available options:
main_branch,
environment,
preview_branch
target_environment_id
string<uuid> | null

Environment ID; required when runtime_target_kind is environment

target_branch_id
string<uuid> | null

Branch ID; required when runtime_target_kind is preview_branch

Response

The available agents.

data
object[]
required

All agents available for the selected runtime target, sorted by name then ID. This complete list is not paginated.