Shipeasy
APIOperations

List review agents

The project's review agents — the evals that score every push to a trail's changes — and the presets that can be added in one call.

The project's review agents — the evals that score every push to a trail's changes — and the presets that can be added in one call.

Use case

Find the agentKey to submit an eval under.

GET
/api/admin/review-agents

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Response Body

application/json

application/json

application/json

curl -X GET "https://shipeasy.ai/api/admin/review-agents"
{
  "agents": [
    {
      "id": "string",
      "key": "string",
      "name": "string",
      "description": "string",
      "instructions": "string",
      "valueType": "score",
      "polarity": "higher_is_better",
      "threshold": 0,
      "blocking": true,
      "trigger": "push",
      "connectorId": "string",
      "preset": "string",
      "enabled": true,
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "presets": [
    {
      "preset": "string",
      "key": "string",
      "name": "string",
      "description": "string",
      "valueType": "score",
      "polarity": "higher_is_better",
      "threshold": 0,
      "blocking": true
    }
  ]
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

Was this page helpful?