Update AI agent brief

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

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

agentIDstringrequired

Request body

requiredapplication/json

business_contextstring

escalation_policyobject

guardrailsobject

objectivestringrequired

response_styleobject

tonestring

Responses

200OK

agent_idstringrequired

business_contextstringrequired

escalation_policyobjectrequired

guardrailsobjectrequired

objectivestringrequired

response_styleobjectrequired

tonestringrequired

updated_atstringrequired

updated_bystring

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/brief" \
  -H "Content-Type: application/json" \
  -d '{
  "business_context": "string",
  "escalation_policy": {},
  "guardrails": {},
  "objective": "string",
  "response_style": {},
  "tone": "string"
}'

const response = await fetch("/v1/ai/agents/string/brief", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "business_context": "string",
  "escalation_policy": {},
  "guardrails": {},
  "objective": "string",
  "response_style": {},
  "tone": "string"
})
});

import requests

response = requests.patch(
    "/v1/ai/agents/string/brief",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "business_context": "string",
  "escalation_policy": {},
  "guardrails": {},
  "objective": "string",
  "response_style": {},
  "tone": "string"
},
)

Response

{
  "agent_id": "string",
  "business_context": "string",
  "escalation_policy": {},
  "guardrails": {},
  "objective": "string",
  "response_style": {},
  "tone": "string",
  "updated_at": "string",
  "updated_by": "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"
  }
}