Shipeasy
APIOperations

Add a review agent

Add a review agent, from a preset (preset: security) or custom (key, name, instructions, and how to read its value). A push agent runs on every push to a…

Add a review agent, from a preset (preset: security) or custom (key, name, instructions, and how to read its value). A push agent runs on every push to a linked PR through the project's coding-agent trigger (or the one named by connectorId) and spends that agent's quota.

Use case

Add the security preset and make it blocking.

POST
/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).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://shipeasy.ai/api/admin/review-agents" \  -H "Content-Type: application/json" \  -d '{    "preset": "security",    "blocking": true  }'
{
  "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"
}
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

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

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "A resource with this name already exists in the project.",
  "code": "ALREADY_EXISTS"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?