AgentScheduleService
Agent Schedules
List schedules
Lists all schedules for an agent
get/v1/workspaces/{workspaceId}/agents/{agentId}/schedules
Path parameters
workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q
Workspace ID.
agentIdstring required
Example:agent_01HXKD2E5NQM3T9AYWCFMGWT9Y
Agent ID. Accepts the canonical agent_… form or the external_id:<value> form.
Query parameters
limitinteger
Maximum number of results to return.
cursorstring
Pagination cursor from previous response.
prefixstring
Filter expression (query param: prefix).
querystring
Free-form search query.
labelsstring
Filters by metadata labels. Comma-separated key=value pairs, e.g. "env=prod,team=ai". A resource matches only if every pair matches exactly (AND semantics).
sortOrderstring
Sort order for results (asc or desc by creation time).
includeInfoboolean
When true, the info field on each returned schedule is populated. Requests with this flag count more against your rate limit.
Response
OK
Example response
{
"items": [
{
"metadata": {
"accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
"workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
"profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
},
"spec": {
"variationId": "agentvar_01HXKD2E5NQM3T9AYWCF32BSPP"
},
"info": {
"lastObjectiveId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
"createdBy": {
"metadata": {
"accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
"profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
}
}
}
}
]
}