Sign in
Agents

Run a smoke test to verify the selected AI CLI works in the environment where agents will actually execute (host or sandbox container). If no `provider_id` is supplied the globally active provider is tested.

post/projects/{project_id}/agents/smoke-test

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{project_id}/agents/smoke-test
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Project ID

Query parameters

provider_idstring

Provider id to test; defaults to the globally active provider

Response

Smoke test result for the AI CLI in the agent's execution environment

auth_infostring nullable

Auth email / method

cli_authenticatedboolean required

Claude CLI authenticated?

cli_installedboolean required

Claude CLI installed?

cli_versionstring nullable

Claude CLI version

detailstring nullable

Full output for debugging

environmentstring required

Where the test ran: "host" or "sandbox"

passedboolean required

Whether the smoke test passed

setup_hintstring nullable

What the user needs to do if the test failed

Changes

No recorded changes to this operation across all 50 revisions of this API.