Sign in

v63

latestOpenAPI 3.0.0Proprietaryraw.githubusercontent.com2026-08-0110571.8 MB
CLI

Ingest CLI codact failures

Accepts CLI-reported codact failures authenticated by user API key and stores them in ClickHouse for later analysis.

post/api/v3.1/cli/codact_failures

Headers

x-user-api-keystring required

User API key used to authenticate the CLI codact failure.

Example:uak_a1b2c3d4e5f6g7h8i9j0k1m2n3p4q5r6s7t8u9v0wXy

Request body

failure_type'wrong_tool_slug' | 'wrong_tool_input_param' required

Type of codact failure being recorded.

ctxobject required

Arbitrary failure context from the CLI.

sessionobject required

Arbitrary session payload from the CLI.

request_idstring

Optional request identifier associated with the failure.

Example request

{
  "failure_type": "wrong_tool_slug",
  "tool_info": {
    "toolkit": "github",
    "tool": {
      "slug": "GITHUB_CREATE_AN_ISSUE",
      "version": "2026.03.23"
    }
  },
  "ctx": {
    "invalid_tool_slug": "GITHUB_MAKE_ISSUE",
    "candidate_tool_slugs": [
      "GITHUB_CREATE_AN_ISSUE"
    ]
  },
  "session": {
    "id": "sess_123",
    "model": "gpt-5.2"
  },
  "request_id": "req_123"
}

Response

CLI codact failure accepted and stored.

trackedboolean required

Whether the codact failure row was accepted for storage.

idstring required

Unique identifier for the stored failure row.

Example response

{
  "tracked": true,
  "id": "5f6f7a1d-72d1-4f7c-bf3a-2fd7421bc123"
}