Change a review agent
Change a review agent's instructions, threshold, polarity, trigger, the connector that runs it, whether it blocks, or switch it off. Its key is fixed.
Change a review agent's instructions, threshold, polarity, trigger, the
connector that runs it, whether it blocks, or switch it off. Its key is
fixed.
Authorization
bearerSdkKey Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".
In: header
Path Parameters
The review agent's id or key.
1 <= length <= 128Header Parameters
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
curl -X PATCH "https://shipeasy.ai/api/admin/review-agents/string" \ -H "Content-Type: application/json" \ -d '{ "threshold": 80, "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": "The request body failed structural (schema) validation.",
"code": "VALIDATION"
}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…
Archive a review agent
Archive a review agent: it stops running and its key is free to reuse. Evals it already submitted stay on their trails.