Prepare multi-Playbook Release (not active)

POST/v1/ai/agents/{agentID}/playbook-releases

Authorization

sessionsessionrequired

Path parameters

agentIDstringrequired

Request body

requiredapplication/json

environmentstringrequired

itemsReleaseItemInput[] | nullrequired

Show properties

Array of ReleaseItemInput

Enabledbooleanrequired

FallbackKindstringrequired

PlaybookIDstringrequired

PlaybookVersionIDstringrequired

Priorityinteger<int64>required

RolloutPercentinteger<int64>required

notesstring

Responses

200OK

activated_atstring

agent_idstringrequired

created_atstringrequired

created_bystring

environmentstringrequired

idstringrequired

itemsReleaseItem[] | null

Show properties

Array of ReleaseItem

enabledbooleanrequired

fallback_kindstringrequired

idstringrequired

playbook_idstringrequired

playbook_version_idstringrequired

priorityinteger<int64>required

release_idstringrequired

rollout_percentinteger<int64>required

notesstring

organization_idstringrequired

previous_release_idstring

statusstringrequired

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

409Conflict

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 POST "/v1/ai/agents/string/playbook-releases" \
  -H "Content-Type: application/json" \
  -d '{
  "environment": "string",
  "items": [
    {
      "Enabled": true,
      "FallbackKind": "string",
      "PlaybookID": "string",
      "PlaybookVersionID": "string",
      "Priority": 0,
      "RolloutPercent": 0
    }
  ],
  "notes": "string"
}'

const response = await fetch("/v1/ai/agents/string/playbook-releases", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "environment": "string",
  "items": [
    {
      "Enabled": true,
      "FallbackKind": "string",
      "PlaybookID": "string",
      "PlaybookVersionID": "string",
      "Priority": 0,
      "RolloutPercent": 0
    }
  ],
  "notes": "string"
})
});

import requests

response = requests.post(
    "/v1/ai/agents/string/playbook-releases",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "environment": "string",
  "items": [
    {
      "Enabled": True,
      "FallbackKind": "string",
      "PlaybookID": "string",
      "PlaybookVersionID": "string",
      "Priority": 0,
      "RolloutPercent": 0
    }
  ],
  "notes": "string"
},
)

Response

{
  "activated_at": "string",
  "agent_id": "string",
  "created_at": "string",
  "created_by": "string",
  "environment": "string",
  "id": "string",
  "items": [
    {
      "enabled": true,
      "fallback_kind": "string",
      "id": "string",
      "playbook_id": "string",
      "playbook_version_id": "string",
      "priority": 0,
      "release_id": "string",
      "rollout_percent": 0
    }
  ],
  "notes": "string",
  "organization_id": "string",
  "previous_release_id": "string",
  "status": "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"
  }
}

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