agents

post/agents

Request

  • Base URL: https://api.fed10.ai/api
  • URL: https://api.fed10.ai/api/agents
  • Auth: API key in header Authorization

Request body

namestring required
base_promptstring required
cadence'interval' | 'hourly' | 'daily' | 'weekdays' | 'weekly' | 'event' required
schedule_timestring
schedule_timezonestring
schedule_weekdayinteger
output_format'text'
delivery_channelsstring[]
artifact_formatsstring[]
capability_grantsstring[]
capability_grant_expirationsobject

Capability ID to ISO expiry with timezone; {} removes deadlines

client_idstring

Exact client ID from this firm; fixed at creation

Example request

{
  "trigger": {
    "any": [
      {
        "source": "bill"
      }
    ]
  },
  "cadence": "interval",
  "output_format": "text",
  "delivery_channels": [
    "in_app"
  ],
  "artifact_formats": [
    "pdf"
  ]
}

Response

Created

idstring required
profile_idstring
client_idstring

Fixed client profile; null means the workspace itself

created_by_idstring
source_kind'custom' | 'flex_alert' | 'smart_alert' | 'digest'
is_sharedboolean
can_manageboolean
namestring required
base_promptstring required
status'draft' | 'active' | 'paused' | 'deleted' required
pause_reason'integration_unavailable' | 'creator_offboarded'
paused_integrationsstring[] required
cadence'interval' | 'hourly' | 'daily' | 'weekdays' | 'weekly' | 'event' required
trigger_labelstring
schedule_timestring required
schedule_timezonestring required
schedule_weekdayinteger
output_format'text' required
delivery_channelsstring[] required
artifact_formatsstring[] required
capability_grantsstring[] required
capability_grant_expirationsobject

Capability ID to ISO expiry with timezone

versioninteger required
next_run_atstring
next_delivery_atstring
estimated_duration_secondsinteger
completion_noticeobject
last_run_atstring
activated_atstring
created_atstring
updated_atstring

Example response

{
  "source_kind": "custom",
  "status": "draft",
  "pause_reason": "integration_unavailable",
  "cadence": "interval",
  "trigger": {
    "any": [
      {
        "source": "bill"
      }
    ]
  },
  "output_format": "text",
  "delivery_channels": [
    "in_app"
  ],
  "artifact_formats": [
    "pdf"
  ],
  "active_run": {
    "kind": "preview"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.