Create or update AI deployment snapshot

PATCH/v1/ai/agents/{agentID}/deploy

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

agentIDstringrequired

Request body

requiredapplication/json

environmentstring

notesstring

playbook_version_idstring

statusstring

Responses

200OK

agent_idstringrequired

appliedbooleanrequired

configobjectrequired

deployed_atstringrequired

deployed_bystring

environmentstringrequired

idstringrequired

modelstringrequired

notesstring

playbook_version_idstring

providerstringrequired

reviewIssueReviewItemView

Show properties

agent_idstringrequired

assigned_tostring

created_atstringrequired

detailsobjectrequired

idstringrequired

issue_typestringrequired

rawSeveritystringrequired

resolved_atstring

severitystringrequired

source_refstring

statusstringrequired

summarystringrequired

titlestringrequired

updatedAtstringrequired

updated_atstringrequired

review_requiredbooleanrequired

statusstringrequired

updated_atstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X PATCH "/v1/ai/agents/string/deploy" \
  -H "Content-Type: application/json" \
  -d '{
  "environment": "string",
  "notes": "string",
  "playbook_version_id": "string",
  "status": "string"
}'

const response = await fetch("/v1/ai/agents/string/deploy", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "environment": "string",
  "notes": "string",
  "playbook_version_id": "string",
  "status": "string"
})
});

import requests

response = requests.patch(
    "/v1/ai/agents/string/deploy",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "environment": "string",
  "notes": "string",
  "playbook_version_id": "string",
  "status": "string"
},
)

Response

{
  "agent_id": "string",
  "applied": true,
  "config": {},
  "deployed_at": "string",
  "deployed_by": "string",
  "environment": "string",
  "id": "string",
  "model": "string",
  "notes": "string",
  "playbook_version_id": "string",
  "provider": "string",
  "review": {
    "agent_id": "string",
    "assigned_to": "string",
    "created_at": "string",
    "details": {},
    "id": "string",
    "issue_type": "string",
    "rawSeverity": "string",
    "resolved_at": "string",
    "severity": "string",
    "source_ref": "string",
    "status": "string",
    "summary": "string",
    "title": "string",
    "updatedAt": "string",
    "updated_at": "string"
  },
  "review_required": true,
  "status": "string",
  "updated_at": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}