Upsert scheduler AI augmentation

Attach or replace the AI augmentation on a scheduled delivery.

PUT /api/v1/schedulers/{schedulerUuid}/ai-augmentation

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "sourceThreadUuid": "<string>",
    "agentUuid": "<string>",
    "prompt": "<string>",
    "type": "agent"
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Path Parameters

schedulerUuid · string<uuid> · required

Stringified UUIDv4. See RFC 4112

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Body

application/json

Option 1

Option 2

Enterprise-only AI augmentation attached to a scheduled delivery. On each fire the agent (or ambient fast model) writes the delivery message from the delivery's content and the prompt. Persisted in the EE scheduler_ai_augmentation satellite table, not on the scheduler itself, so OSS carries none of it.

sourceThreadUuid · string | null · required

agentUuid · string · required

prompt · string · required

type · enum<string> · required

Available options: agent

Response

200

application/json

Success

results · object · required

Enterprise-only AI augmentation attached to a scheduled delivery. On each fire the agent (or ambient fast model) writes the delivery message from the delivery's content and the prompt. Persisted in the EE scheduler_ai_augmentation satellite table, not on the scheduler itself, so OSS carries none of it.

Option 1

Option 2

Show child attributes

status · enum<string> · required

Available options: ok