Agentuity Documentation

Create and manage cron-based scheduled jobs with destinations and delivery tracking.

Region

https://catalyst-usw.agentuity.cloud

Authentication

All requests require a Bearer token. Pass your SDK key in the Authorization header.

Header	Value
`Authorization`	`Bearer YOUR_SDK_KEY`

You can find your SDK key in the Agentuity Console under your project settings.

Schedule Management

Create Schedule

Create a new cron-based schedule with optional destinations.

POST/schedule/create

https://catalyst-usw.agentuity.cloud/schedule/create

Request Body

Schedule creation payload.

Field	Type	Description
`name`	string	Human-readable name for the schedule.
`description`	string	Optional description of the schedule's purpose. (optional)
`expression`	string	Cron expression defining when the schedule fires
`destinations`	object[]	Optional array of destinations to create alongside the schedule. (optional)
`destinations[].type`	string	The destination type: `'url'` for HTTP endpoints or `'sandbox'` for Agentuity sandbox execution.
`destinations[].config`	object	Type-specific destination configuration.

Response

Returns the created schedule and its destinations.

Status	Description
201	Schedule created
401	Unauthorized — invalid or missing Bearer token

Response Fields

Field	Type	Description
`schedule`	object	The newly created schedule record.
`schedule.id`	string	Unique identifier for the schedule.
`schedule.created_at`	string	ISO 8601 timestamp when the schedule was created.
`schedule.updated_at`	string	ISO 8601 timestamp when the schedule was last modified.
`schedule.created_by`	string	ID of the user who created the schedule.
`schedule.name`	string	Human-readable name for the schedule.
`schedule.description`	string \| null	Optional description of the schedule's purpose.
`schedule.expression`	string	A cron expression defining the schedule's firing interval
`schedule.due_date`	string	ISO 8601 timestamp of the next scheduled execution.
`destinations`	object[]	Array of destinations that were created alongside the schedule.
`destinations[].id`	string	Unique identifier for the destination.
`destinations[].schedule_id`	string	The ID of the parent schedule.
`destinations[].created_at`	string	ISO 8601 timestamp when the destination was created.
`destinations[].updated_at`	string	ISO 8601 timestamp when the destination was last updated.
`destinations[].created_by`	string	ID of the user who created the destination.
`destinations[].type`	string	The destination type: `'url'` for HTTP endpoints or `'sandbox'` for Agentuity sandbox execution.
`destinations[].config`	object	Type-specific destination configuration.

Example

curl -X POST 'https://catalyst-usw.agentuity.cloud/schedule/create' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Daily Report",
  "expression": "0 9 * * *",
  "destinations": [
    {
      "type": "url",
      "config": {
        "url": "https://example.com/webhook"
      }
    }
  ]
}'

List Schedules

List all schedules with optional pagination.

GET/schedule/list

https://catalyst-usw.agentuity.cloud/schedule/list

Parameters

query

Name	Type	Required	Description
`limit`	number	No	Max results (max 500)
`offset`	number	No	Pagination offset

Response

Returns paginated list of schedules.

Status	Description
200	Schedules returned
401	Unauthorized — invalid or missing Bearer token

Response Fields

Field	Type	Description
`schedules`	object[]	Array of schedule records for the current page.
`schedules[].id`	string	Unique identifier for the schedule.
`schedules[].created_at`	string	ISO 8601 timestamp when the schedule was created.
`schedules[].updated_at`	string	ISO 8601 timestamp when the schedule was last modified.
`schedules[].created_by`	string	ID of the user who created the schedule.
`schedules[].name`	string	Human-readable name for the schedule.
`schedules[].description`	string \| null	Optional description of the schedule's purpose.
`schedules[].expression`	string	A cron expression defining the schedule's firing interval
`schedules[].due_date`	string	ISO 8601 timestamp of the next scheduled execution.
`total`	number	Total number of schedules across all pages.

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/schedule/list' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Get Schedule

Get a specific schedule by ID.

GET/schedule/get/{scheduleId}

https://catalyst-usw.agentuity.cloud/schedule/get/{scheduleId}

Parameters

path

Name	Type	Required	Description
`scheduleId`	string	Yes	Schedule ID (sch_ prefix)

Response

Returns the schedule object.

Status	Description
200	Schedule returned
401	Unauthorized — invalid or missing Bearer token
404	Schedule not found

Response Fields

Field	Type	Description
`schedule`	object	The schedule record.
`schedule.id`	string	Unique identifier for the schedule.
`schedule.created_at`	string	ISO 8601 timestamp when the schedule was created.
`schedule.updated_at`	string	ISO 8601 timestamp when the schedule was last modified.
`schedule.created_by`	string	ID of the user who created the schedule.
`schedule.name`	string	Human-readable name for the schedule.
`schedule.description`	string \| null	Optional description of the schedule's purpose.
`schedule.expression`	string	A cron expression defining the schedule's firing interval
`schedule.due_date`	string	ISO 8601 timestamp of the next scheduled execution.
`destinations`	object[]	Array of destinations configured for this schedule.
`destinations[].id`	string	Unique identifier for the destination.
`destinations[].schedule_id`	string	The ID of the parent schedule.
`destinations[].created_at`	string	ISO 8601 timestamp when the destination was created.
`destinations[].updated_at`	string	ISO 8601 timestamp when the destination was last updated.
`destinations[].created_by`	string	ID of the user who created the destination.
`destinations[].type`	string	The destination type: `'url'` for HTTP endpoints or `'sandbox'` for Agentuity sandbox execution.
`destinations[].config`	object	Type-specific destination configuration.

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/schedule/get/sch_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Update Schedule

Update a schedule's name, description, or cron expression.

PUT/schedule/update/{scheduleId}

https://catalyst-usw.agentuity.cloud/schedule/update/{scheduleId}

Parameters

path

Name	Type	Required	Description
`scheduleId`	string	Yes	Schedule ID

Request Body

Fields to update.

Field	Type	Description
`name`	string	Updated human-readable name for the schedule. (optional)
`description`	string	Updated description. (optional)
`expression`	string	Updated cron expression. If changed, the `due_date` is automatically recomputed. (optional)

Response

Returns the updated schedule.

Status	Description
200	Schedule updated
401	Unauthorized — invalid or missing Bearer token
404	Schedule not found

Response Fields

Field	Type	Description
`schedule`	object	The updated schedule record.
`schedule.id`	string	Unique identifier for the schedule.
`schedule.created_at`	string	ISO 8601 timestamp when the schedule was created.
`schedule.updated_at`	string	ISO 8601 timestamp when the schedule was last modified.
`schedule.created_by`	string	ID of the user who created the schedule.
`schedule.name`	string	Human-readable name for the schedule.
`schedule.description`	string \| null	Optional description of the schedule's purpose.
`schedule.expression`	string	A cron expression defining the schedule's firing interval
`schedule.due_date`	string	ISO 8601 timestamp of the next scheduled execution.

Example

curl -X PUT 'https://catalyst-usw.agentuity.cloud/schedule/update/sch_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "expression": "0 */6 * * *"
}'

Delete Schedule

Delete a schedule and all associated destinations and delivery history.

DELETE/schedule/delete/{scheduleId}

https://catalyst-usw.agentuity.cloud/schedule/delete/{scheduleId}

Parameters

path

Name	Type	Required	Description
`scheduleId`	string	Yes	Schedule ID

Response

Deletes the schedule and all associated destinations and delivery history.

Status	Description
204	Schedule deleted
401	Unauthorized — invalid or missing Bearer token
404	Schedule not found

Example

curl -X DELETE 'https://catalyst-usw.agentuity.cloud/schedule/delete/sch_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Destinations

Create Destination

Add a destination to a schedule.

POST/schedule/destinations/create/{scheduleId}

https://catalyst-usw.agentuity.cloud/schedule/destinations/create/{scheduleId}

Parameters

path

Name	Type	Required	Description
`scheduleId`	string	Yes	Schedule ID

Request Body

Destination creation payload.

Field	Type	Description
`type`	string	The destination type: `'url'` for HTTP endpoints or `'sandbox'` for Agentuity sandbox execution.
`config`	object	Type-specific destination configuration.

Response

Returns the created destination.

Status	Description
201	Destination created
401	Unauthorized — invalid or missing Bearer token
404	Schedule not found

Response Fields

Field	Type	Description
`destination`	object	The newly created destination record.
`destination.id`	string	Unique identifier for the destination.
`destination.schedule_id`	string	The ID of the parent schedule.
`destination.created_at`	string	ISO 8601 timestamp when the destination was created.
`destination.updated_at`	string	ISO 8601 timestamp when the destination was last updated.
`destination.created_by`	string	ID of the user who created the destination.
`destination.type`	string	The destination type: `'url'` for HTTP endpoints or `'sandbox'` for Agentuity sandbox execution.
`destination.config`	object	Type-specific destination configuration.

Example

curl -X POST 'https://catalyst-usw.agentuity.cloud/schedule/destinations/create/sch_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "url",
  "config": {
    "url": "https://example.com/callback",
    "method": "POST"
  }
}'

Delete Destination

Delete a destination from a schedule.

DELETE/schedule/destinations/delete/{destinationId}

https://catalyst-usw.agentuity.cloud/schedule/destinations/delete/{destinationId}

Parameters

path

Name	Type	Required	Description
`destinationId`	string	Yes	Destination ID (sdst_ prefix)

Response

Empty response on success.

Status	Description
204	Destination deleted
401	Unauthorized — invalid or missing Bearer token
404	Destination not found

Example

curl -X DELETE 'https://catalyst-usw.agentuity.cloud/schedule/destinations/delete/sdst_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Deliveries

List Deliveries

List delivery attempts for a schedule.

GET/schedule/deliveries/{scheduleId}

https://catalyst-usw.agentuity.cloud/schedule/deliveries/{scheduleId}

Parameters

path

Name	Type	Required	Description
`scheduleId`	string	Yes	Schedule ID

query

Name	Type	Required	Description
`limit`	number	No	Maximum results to return
`offset`	number	No	Pagination offset

Response

Returns delivery attempts with status, retries, and error details.

Status	Description
200	Deliveries returned
401	Unauthorized — invalid or missing Bearer token
404	Schedule not found

Response Fields

Field	Type	Description
`deliveries`	object[]	Array of delivery attempt records.
`deliveries[].id`	string	Unique identifier for the delivery attempt.
`deliveries[].date`	string	ISO 8601 timestamp when the delivery was attempted.
`deliveries[].schedule_id`	string	The ID of the schedule that triggered this delivery.
`deliveries[].schedule_destination_id`	string	The ID of the destination this delivery was sent to.
`deliveries[].status`	string	Delivery status: `'pending'` (queued), `'success'` (delivered), or `'failed'` (delivery error).
`deliveries[].retries`	number	Number of retry attempts made for this delivery.
`deliveries[].error`	string \| null	Error message if the delivery failed, `null` on success.
`deliveries[].response`	object \| null	The response received from the destination, or `null` if no response.

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/schedule/deliveries/sch_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'