API Keys

The feature switches and the paths that reviews skip. No parameters.

{
  "excludedConfig": [
    {
      "repoName": str,
      "paths": str[],
      "repoId": uuid
    }
  ],
  "orgConfig": [
    {
      "key": str,
      "configurationId": uuid,
      "enabled": bool,
      "configurationMetadata": object
    }
  ]
}

{
  "reviewers": [
    {
      "id": uuid,
      "title": str,
      "description": str,
      "enabled": bool,
      "activeVersion": number,
      "scopes": array,
      "discussions": array,
      "canEdit": bool,
      "createdAt": str,
      "updatedAt": str
    }
  ]
}

Discussions on the newest pull request on a branch: file location, commented code, status, and the full comment thread.

[
  {
    "id": uuid,
    "file": str,
    "startLine": number,
    "endLine": number,
    "commentedCode": str,
    "status": str,
    "reviewerTitle": str,
    "comments": [
      {
        "author": str,
        "body": str,
        "createdAt": str
      }
    ]
  }
]

status in the reply is open, resolved, or addressed.

{
  "items": str[],
  "total": number,
  "truncated": bool
}

An ambiguous repository returns a candidate list instead: { "candidates": str[] }.

{
  "repository": str,
  "pattern": str,
  "path": str,
  "ref": str
}

Reply: { "text": str }, or a candidate list if repository is ambiguous.

{
  "keywords": str[],
  "domains": str[]
}

{
  "summaries": [
    {
      "repoId": uuid,
      "repoName": str,
      "domain": str,
      "summary": str
    }
  ]
}

{
  "sessionId": uuid,
  "eventType": str,
  "repository": str,
  "agentVendor": str,
  "payload": object
}

Reply: 204 with no body.

Baz matches the plan by seriesKey, so posting again with the same key adds a version instead of a new plan.

{
  "seriesKey": uuid,
  "content": str,
  "agentVendor": str,
  "repoNames": str[],
  "modelId": str,
  "tokensUsed": {
    "input_tokens": number,
    "output_tokens": number
  }
}

Reply: 201 for a new plan, 200 for a new version, with status one of pending, approved, implemented, closed, deleted.

Path parameter: seriesId (UUID).

{
  "comments": [
    {
      "id": uuid,
      "versionId": uuid,
      "parentId": uuid | null,
      "body": str,
      "authorName": str,
      "anchor": str | null,
      "triageState": str | null,
      "createdAt": str
    }
  ],
  "mutedThreadIds": uuid[]
}

triageState is open, dismissed, or null.

Path parameter: seriesId (UUID).

{
  "body": str,
  "versionId": uuid,
  "parentId": uuid,
  "anchor": str
}

Reply: 201 with the new comment, shaped like the list above.

Path parameters: seriesId (UUID), commentId (UUID).

{
  "body": str,
  "triageState": str
}

Reply: 200 with the updated comment.

Path parameter: seriesId (UUID). If the plan is still pending, linking a PR marks it implemented.

{
  "repoName": str,
  "prNumber": number
}

Reply: 200 with the plan, shaped like the reply to POST /api/v2/plans.

No. The secret is shown once, at creation. If you lose it, revoke the key and generate a new one.

Not beyond the endpoints listed above. A key carries the full permissions of the user who created it on those endpoints; there is no separate scope or role picker when generating one.

No. Revoking a key only stops requests authenticated with that specific key. Your other keys, and your normal login session, are unaffected.