Skip to content
agentex-sdk
API Reference
Agents

Schedules

Create Run Schedule
POST/agents/{agent_id}/schedules
List Run Schedules
GET/agents/{agent_id}/schedules
Get Run Schedule
GET/agents/{agent_id}/schedules/{schedule_id}
Update Run Schedule
PATCH/agents/{agent_id}/schedules/{schedule_id}
Delete Run Schedule
DELETE/agents/{agent_id}/schedules/{schedule_id}
Pause Run Schedule
POST/agents/{agent_id}/schedules/{schedule_id}/pause
Resume Run Schedule
POST/agents/{agent_id}/schedules/{schedule_id}/resume
Trigger Run Schedule
POST/agents/{agent_id}/schedules/{schedule_id}/trigger
Skip Run Schedule Action
POST/agents/{agent_id}/schedules/{schedule_id}/skip
Unskip Run Schedule Action
POST/agents/{agent_id}/schedules/{schedule_id}/unskip
Get Run Schedule By Name
GET/agents/{agent_id}/schedules/name/{name}
Update Run Schedule By Name
PATCH/agents/{agent_id}/schedules/name/{name}
Delete Run Schedule By Name
DELETE/agents/{agent_id}/schedules/name/{name}
Pause Run Schedule By Name
POST/agents/{agent_id}/schedules/name/{name}/pause
Resume Run Schedule By Name
POST/agents/{agent_id}/schedules/name/{name}/resume
Trigger Run Schedule By Name
POST/agents/{agent_id}/schedules/name/{name}/trigger
ModelsExpand Collapse
ScheduleCreateResponse object { id, agent_id, initial_input, 20 more }

Response model describing a scheduled agent run.

id: string

The unique identifier of the run schedule.

agent_id: string

The agent this schedule belongs to.

initial_input: object { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author: optional MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type: optional "text"

Input content type.

initial_input_method: string

Delivery method, inferred from the agent’s ACP type.

name: string

Human-readable schedule name.

created_at: optional string

When the schedule was created.

formatdate-time
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }

Credential-free creator identity stored with the schedule.

Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.

account_id: optional string

Account/workspace id of the creator.

principal_type: optional string

e.g. ‘user’ or ‘service_account’.

service_account_id: optional string

Creator service-account id, if a service principal.

user_id: optional string

Creator user id, if a user principal.

cron_expression: optional string

Cron cadence, if cron-based.

description: optional string

Optional description.

end_at: optional string

Schedule deactivation time.

formatdate-time
interval_seconds: optional number

Interval cadence in seconds, if interval-based.

last_action_time: optional string

When the schedule last fired.

formatdate-time
live_data_available: optional boolean

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: optional array of string

Upcoming scheduled fire times.

num_actions_taken: optional number

Number of times the schedule has fired.

paused: optional boolean

Whether the schedule is paused.

skipped_action_times: optional array of string

Skipped one-off scheduled fire times.

start_at: optional string

Schedule activation time.

formatdate-time
state: optional "ACTIVE" or "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata: optional map[unknown]

Task metadata at fire time.

task_params: optional map[unknown]

Task params at fire time.

timezone: optional string

Timezone the cron expression is evaluated in.

updated_at: optional string

When the schedule was updated.

formatdate-time
ScheduleListResponse object { run_schedules, total }

Response model for listing run schedules.

run_schedules: array of object { id, agent_id, initial_input, 20 more }

The list of run schedules.

id: string

The unique identifier of the run schedule.

agent_id: string

The agent this schedule belongs to.

initial_input: object { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author: optional MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type: optional "text"

Input content type.

initial_input_method: string

Delivery method, inferred from the agent’s ACP type.

name: string

Human-readable schedule name.

created_at: optional string

When the schedule was created.

formatdate-time
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }

Credential-free creator identity stored with the schedule.

Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.

account_id: optional string

Account/workspace id of the creator.

principal_type: optional string

e.g. ‘user’ or ‘service_account’.

service_account_id: optional string

Creator service-account id, if a service principal.

user_id: optional string

Creator user id, if a user principal.

cron_expression: optional string

Cron cadence, if cron-based.

description: optional string

Optional description.

end_at: optional string

Schedule deactivation time.

formatdate-time
interval_seconds: optional number

Interval cadence in seconds, if interval-based.

last_action_time: optional string

When the schedule last fired.

formatdate-time
live_data_available: optional boolean

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: optional array of string

Upcoming scheduled fire times.

num_actions_taken: optional number

Number of times the schedule has fired.

paused: optional boolean

Whether the schedule is paused.

skipped_action_times: optional array of string

Skipped one-off scheduled fire times.

start_at: optional string

Schedule activation time.

formatdate-time
state: optional "ACTIVE" or "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata: optional map[unknown]

Task metadata at fire time.

task_params: optional map[unknown]

Task params at fire time.

timezone: optional string

Timezone the cron expression is evaluated in.

updated_at: optional string

When the schedule was updated.

formatdate-time
total: number

The number of run schedules returned.

ScheduleRetrieveResponse object { id, agent_id, initial_input, 20 more }

Response model describing a scheduled agent run.

id: string

The unique identifier of the run schedule.

agent_id: string

The agent this schedule belongs to.

initial_input: object { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author: optional MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type: optional "text"

Input content type.

initial_input_method: string

Delivery method, inferred from the agent’s ACP type.

name: string

Human-readable schedule name.

created_at: optional string

When the schedule was created.

formatdate-time
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }

Credential-free creator identity stored with the schedule.

Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.

account_id: optional string

Account/workspace id of the creator.

principal_type: optional string

e.g. ‘user’ or ‘service_account’.

service_account_id: optional string

Creator service-account id, if a service principal.

user_id: optional string

Creator user id, if a user principal.

cron_expression: optional string

Cron cadence, if cron-based.

description: optional string

Optional description.

end_at: optional string

Schedule deactivation time.

formatdate-time
interval_seconds: optional number

Interval cadence in seconds, if interval-based.

last_action_time: optional string

When the schedule last fired.

formatdate-time
live_data_available: optional boolean

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: optional array of string

Upcoming scheduled fire times.

num_actions_taken: optional number

Number of times the schedule has fired.

paused: optional boolean

Whether the schedule is paused.

skipped_action_times: optional array of string

Skipped one-off scheduled fire times.

start_at: optional string

Schedule activation time.

formatdate-time
state: optional "ACTIVE" or "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata: optional map[unknown]

Task metadata at fire time.

task_params: optional map[unknown]

Task params at fire time.

timezone: optional string

Timezone the cron expression is evaluated in.

updated_at: optional string

When the schedule was updated.

formatdate-time
ScheduleUpdateResponse object { id, agent_id, initial_input, 20 more }

Response model describing a scheduled agent run.

id: string

The unique identifier of the run schedule.

agent_id: string

The agent this schedule belongs to.

initial_input: object { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author: optional MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type: optional "text"

Input content type.

initial_input_method: string

Delivery method, inferred from the agent’s ACP type.

name: string

Human-readable schedule name.

created_at: optional string

When the schedule was created.

formatdate-time
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }

Credential-free creator identity stored with the schedule.

Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.

account_id: optional string

Account/workspace id of the creator.

principal_type: optional string

e.g. ‘user’ or ‘service_account’.

service_account_id: optional string

Creator service-account id, if a service principal.

user_id: optional string

Creator user id, if a user principal.

cron_expression: optional string

Cron cadence, if cron-based.

description: optional string

Optional description.

end_at: optional string

Schedule deactivation time.

formatdate-time
interval_seconds: optional number

Interval cadence in seconds, if interval-based.

last_action_time: optional string

When the schedule last fired.

formatdate-time
live_data_available: optional boolean

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: optional array of string

Upcoming scheduled fire times.

num_actions_taken: optional number

Number of times the schedule has fired.

paused: optional boolean

Whether the schedule is paused.

skipped_action_times: optional array of string

Skipped one-off scheduled fire times.

start_at: optional string

Schedule activation time.

formatdate-time
state: optional "ACTIVE" or "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata: optional map[unknown]

Task metadata at fire time.

task_params: optional map[unknown]

Task params at fire time.

timezone: optional string

Timezone the cron expression is evaluated in.

updated_at: optional string

When the schedule was updated.

formatdate-time
SchedulePauseResponse object { id, agent_id, initial_input, 20 more }

Response model describing a scheduled agent run.

id: string

The unique identifier of the run schedule.

agent_id: string

The agent this schedule belongs to.

initial_input: object { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author: optional MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type: optional "text"

Input content type.

initial_input_method: string

Delivery method, inferred from the agent’s ACP type.

name: string

Human-readable schedule name.

created_at: optional string

When the schedule was created.

formatdate-time
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }

Credential-free creator identity stored with the schedule.

Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.

account_id: optional string

Account/workspace id of the creator.

principal_type: optional string

e.g. ‘user’ or ‘service_account’.

service_account_id: optional string

Creator service-account id, if a service principal.

user_id: optional string

Creator user id, if a user principal.

cron_expression: optional string

Cron cadence, if cron-based.

description: optional string

Optional description.

end_at: optional string

Schedule deactivation time.

formatdate-time
interval_seconds: optional number

Interval cadence in seconds, if interval-based.

last_action_time: optional string

When the schedule last fired.

formatdate-time
live_data_available: optional boolean

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: optional array of string

Upcoming scheduled fire times.

num_actions_taken: optional number

Number of times the schedule has fired.

paused: optional boolean

Whether the schedule is paused.

skipped_action_times: optional array of string

Skipped one-off scheduled fire times.

start_at: optional string

Schedule activation time.

formatdate-time
state: optional "ACTIVE" or "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata: optional map[unknown]

Task metadata at fire time.

task_params: optional map[unknown]

Task params at fire time.

timezone: optional string

Timezone the cron expression is evaluated in.

updated_at: optional string

When the schedule was updated.

formatdate-time
ScheduleResumeResponse object { id, agent_id, initial_input, 20 more }

Response model describing a scheduled agent run.

id: string

The unique identifier of the run schedule.

agent_id: string

The agent this schedule belongs to.

initial_input: object { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author: optional MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type: optional "text"

Input content type.

initial_input_method: string

Delivery method, inferred from the agent’s ACP type.

name: string

Human-readable schedule name.

created_at: optional string

When the schedule was created.

formatdate-time
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }

Credential-free creator identity stored with the schedule.

Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.

account_id: optional string

Account/workspace id of the creator.

principal_type: optional string

e.g. ‘user’ or ‘service_account’.

service_account_id: optional string

Creator service-account id, if a service principal.

user_id: optional string

Creator user id, if a user principal.

cron_expression: optional string

Cron cadence, if cron-based.

description: optional string

Optional description.

end_at: optional string

Schedule deactivation time.

formatdate-time
interval_seconds: optional number

Interval cadence in seconds, if interval-based.

last_action_time: optional string

When the schedule last fired.

formatdate-time
live_data_available: optional boolean

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: optional array of string

Upcoming scheduled fire times.

num_actions_taken: optional number

Number of times the schedule has fired.

paused: optional boolean

Whether the schedule is paused.

skipped_action_times: optional array of string

Skipped one-off scheduled fire times.

start_at: optional string

Schedule activation time.

formatdate-time
state: optional "ACTIVE" or "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata: optional map[unknown]

Task metadata at fire time.

task_params: optional map[unknown]

Task params at fire time.

timezone: optional string

Timezone the cron expression is evaluated in.

updated_at: optional string

When the schedule was updated.

formatdate-time
ScheduleTriggerResponse object { id, agent_id, initial_input, 20 more }

Response model describing a scheduled agent run.

id: string

The unique identifier of the run schedule.

agent_id: string

The agent this schedule belongs to.

initial_input: object { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author: optional MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type: optional "text"

Input content type.

initial_input_method: string

Delivery method, inferred from the agent’s ACP type.

name: string

Human-readable schedule name.

created_at: optional string

When the schedule was created.

formatdate-time
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }

Credential-free creator identity stored with the schedule.

Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.

account_id: optional string

Account/workspace id of the creator.

principal_type: optional string

e.g. ‘user’ or ‘service_account’.

service_account_id: optional string

Creator service-account id, if a service principal.

user_id: optional string

Creator user id, if a user principal.

cron_expression: optional string

Cron cadence, if cron-based.

description: optional string

Optional description.

end_at: optional string

Schedule deactivation time.

formatdate-time
interval_seconds: optional number

Interval cadence in seconds, if interval-based.

last_action_time: optional string

When the schedule last fired.

formatdate-time
live_data_available: optional boolean

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: optional array of string

Upcoming scheduled fire times.

num_actions_taken: optional number

Number of times the schedule has fired.

paused: optional boolean

Whether the schedule is paused.

skipped_action_times: optional array of string

Skipped one-off scheduled fire times.

start_at: optional string

Schedule activation time.

formatdate-time
state: optional "ACTIVE" or "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata: optional map[unknown]

Task metadata at fire time.

task_params: optional map[unknown]

Task params at fire time.

timezone: optional string

Timezone the cron expression is evaluated in.

updated_at: optional string

When the schedule was updated.

formatdate-time
ScheduleSkipResponse object { id, agent_id, initial_input, 20 more }

Response model describing a scheduled agent run.

id: string

The unique identifier of the run schedule.

agent_id: string

The agent this schedule belongs to.

initial_input: object { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author: optional MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type: optional "text"

Input content type.

initial_input_method: string

Delivery method, inferred from the agent’s ACP type.

name: string

Human-readable schedule name.

created_at: optional string

When the schedule was created.

formatdate-time
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }

Credential-free creator identity stored with the schedule.

Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.

account_id: optional string

Account/workspace id of the creator.

principal_type: optional string

e.g. ‘user’ or ‘service_account’.

service_account_id: optional string

Creator service-account id, if a service principal.

user_id: optional string

Creator user id, if a user principal.

cron_expression: optional string

Cron cadence, if cron-based.

description: optional string

Optional description.

end_at: optional string

Schedule deactivation time.

formatdate-time
interval_seconds: optional number

Interval cadence in seconds, if interval-based.

last_action_time: optional string

When the schedule last fired.

formatdate-time
live_data_available: optional boolean

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: optional array of string

Upcoming scheduled fire times.

num_actions_taken: optional number

Number of times the schedule has fired.

paused: optional boolean

Whether the schedule is paused.

skipped_action_times: optional array of string

Skipped one-off scheduled fire times.

start_at: optional string

Schedule activation time.

formatdate-time
state: optional "ACTIVE" or "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata: optional map[unknown]

Task metadata at fire time.

task_params: optional map[unknown]

Task params at fire time.

timezone: optional string

Timezone the cron expression is evaluated in.

updated_at: optional string

When the schedule was updated.

formatdate-time
ScheduleUnskipResponse object { id, agent_id, initial_input, 20 more }

Response model describing a scheduled agent run.

id: string

The unique identifier of the run schedule.

agent_id: string

The agent this schedule belongs to.

initial_input: object { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author: optional MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type: optional "text"

Input content type.

initial_input_method: string

Delivery method, inferred from the agent’s ACP type.

name: string

Human-readable schedule name.

created_at: optional string

When the schedule was created.

formatdate-time
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }

Credential-free creator identity stored with the schedule.

Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.

account_id: optional string

Account/workspace id of the creator.

principal_type: optional string

e.g. ‘user’ or ‘service_account’.

service_account_id: optional string

Creator service-account id, if a service principal.

user_id: optional string

Creator user id, if a user principal.

cron_expression: optional string

Cron cadence, if cron-based.

description: optional string

Optional description.

end_at: optional string

Schedule deactivation time.

formatdate-time
interval_seconds: optional number

Interval cadence in seconds, if interval-based.

last_action_time: optional string

When the schedule last fired.

formatdate-time
live_data_available: optional boolean

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: optional array of string

Upcoming scheduled fire times.

num_actions_taken: optional number

Number of times the schedule has fired.

paused: optional boolean

Whether the schedule is paused.

skipped_action_times: optional array of string

Skipped one-off scheduled fire times.

start_at: optional string

Schedule activation time.

formatdate-time
state: optional "ACTIVE" or "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata: optional map[unknown]

Task metadata at fire time.

task_params: optional map[unknown]

Task params at fire time.

timezone: optional string

Timezone the cron expression is evaluated in.

updated_at: optional string

When the schedule was updated.

formatdate-time
ScheduleRetrieveByNameResponse object { id, agent_id, initial_input, 20 more }

Response model describing a scheduled agent run.

id: string

The unique identifier of the run schedule.

agent_id: string

The agent this schedule belongs to.

initial_input: object { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author: optional MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type: optional "text"

Input content type.

initial_input_method: string

Delivery method, inferred from the agent’s ACP type.

name: string

Human-readable schedule name.

created_at: optional string

When the schedule was created.

formatdate-time
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }

Credential-free creator identity stored with the schedule.

Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.

account_id: optional string

Account/workspace id of the creator.

principal_type: optional string

e.g. ‘user’ or ‘service_account’.

service_account_id: optional string

Creator service-account id, if a service principal.

user_id: optional string

Creator user id, if a user principal.

cron_expression: optional string

Cron cadence, if cron-based.

description: optional string

Optional description.

end_at: optional string

Schedule deactivation time.

formatdate-time
interval_seconds: optional number

Interval cadence in seconds, if interval-based.

last_action_time: optional string

When the schedule last fired.

formatdate-time
live_data_available: optional boolean

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: optional array of string

Upcoming scheduled fire times.

num_actions_taken: optional number

Number of times the schedule has fired.

paused: optional boolean

Whether the schedule is paused.

skipped_action_times: optional array of string

Skipped one-off scheduled fire times.

start_at: optional string

Schedule activation time.

formatdate-time
state: optional "ACTIVE" or "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata: optional map[unknown]

Task metadata at fire time.

task_params: optional map[unknown]

Task params at fire time.

timezone: optional string

Timezone the cron expression is evaluated in.

updated_at: optional string

When the schedule was updated.

formatdate-time
ScheduleUpdateByNameResponse object { id, agent_id, initial_input, 20 more }

Response model describing a scheduled agent run.

id: string

The unique identifier of the run schedule.

agent_id: string

The agent this schedule belongs to.

initial_input: object { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author: optional MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type: optional "text"

Input content type.

initial_input_method: string

Delivery method, inferred from the agent’s ACP type.

name: string

Human-readable schedule name.

created_at: optional string

When the schedule was created.

formatdate-time
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }

Credential-free creator identity stored with the schedule.

Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.

account_id: optional string

Account/workspace id of the creator.

principal_type: optional string

e.g. ‘user’ or ‘service_account’.

service_account_id: optional string

Creator service-account id, if a service principal.

user_id: optional string

Creator user id, if a user principal.

cron_expression: optional string

Cron cadence, if cron-based.

description: optional string

Optional description.

end_at: optional string

Schedule deactivation time.

formatdate-time
interval_seconds: optional number

Interval cadence in seconds, if interval-based.

last_action_time: optional string

When the schedule last fired.

formatdate-time
live_data_available: optional boolean

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: optional array of string

Upcoming scheduled fire times.

num_actions_taken: optional number

Number of times the schedule has fired.

paused: optional boolean

Whether the schedule is paused.

skipped_action_times: optional array of string

Skipped one-off scheduled fire times.

start_at: optional string

Schedule activation time.

formatdate-time
state: optional "ACTIVE" or "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata: optional map[unknown]

Task metadata at fire time.

task_params: optional map[unknown]

Task params at fire time.

timezone: optional string

Timezone the cron expression is evaluated in.

updated_at: optional string

When the schedule was updated.

formatdate-time
SchedulePauseByNameResponse object { id, agent_id, initial_input, 20 more }

Response model describing a scheduled agent run.

id: string

The unique identifier of the run schedule.

agent_id: string

The agent this schedule belongs to.

initial_input: object { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author: optional MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type: optional "text"

Input content type.

initial_input_method: string

Delivery method, inferred from the agent’s ACP type.

name: string

Human-readable schedule name.

created_at: optional string

When the schedule was created.

formatdate-time
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }

Credential-free creator identity stored with the schedule.

Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.

account_id: optional string

Account/workspace id of the creator.

principal_type: optional string

e.g. ‘user’ or ‘service_account’.

service_account_id: optional string

Creator service-account id, if a service principal.

user_id: optional string

Creator user id, if a user principal.

cron_expression: optional string

Cron cadence, if cron-based.

description: optional string

Optional description.

end_at: optional string

Schedule deactivation time.

formatdate-time
interval_seconds: optional number

Interval cadence in seconds, if interval-based.

last_action_time: optional string

When the schedule last fired.

formatdate-time
live_data_available: optional boolean

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: optional array of string

Upcoming scheduled fire times.

num_actions_taken: optional number

Number of times the schedule has fired.

paused: optional boolean

Whether the schedule is paused.

skipped_action_times: optional array of string

Skipped one-off scheduled fire times.

start_at: optional string

Schedule activation time.

formatdate-time
state: optional "ACTIVE" or "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata: optional map[unknown]

Task metadata at fire time.

task_params: optional map[unknown]

Task params at fire time.

timezone: optional string

Timezone the cron expression is evaluated in.

updated_at: optional string

When the schedule was updated.

formatdate-time
ScheduleResumeByNameResponse object { id, agent_id, initial_input, 20 more }

Response model describing a scheduled agent run.

id: string

The unique identifier of the run schedule.

agent_id: string

The agent this schedule belongs to.

initial_input: object { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author: optional MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type: optional "text"

Input content type.

initial_input_method: string

Delivery method, inferred from the agent’s ACP type.

name: string

Human-readable schedule name.

created_at: optional string

When the schedule was created.

formatdate-time
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }

Credential-free creator identity stored with the schedule.

Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.

account_id: optional string

Account/workspace id of the creator.

principal_type: optional string

e.g. ‘user’ or ‘service_account’.

service_account_id: optional string

Creator service-account id, if a service principal.

user_id: optional string

Creator user id, if a user principal.

cron_expression: optional string

Cron cadence, if cron-based.

description: optional string

Optional description.

end_at: optional string

Schedule deactivation time.

formatdate-time
interval_seconds: optional number

Interval cadence in seconds, if interval-based.

last_action_time: optional string

When the schedule last fired.

formatdate-time
live_data_available: optional boolean

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: optional array of string

Upcoming scheduled fire times.

num_actions_taken: optional number

Number of times the schedule has fired.

paused: optional boolean

Whether the schedule is paused.

skipped_action_times: optional array of string

Skipped one-off scheduled fire times.

start_at: optional string

Schedule activation time.

formatdate-time
state: optional "ACTIVE" or "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata: optional map[unknown]

Task metadata at fire time.

task_params: optional map[unknown]

Task params at fire time.

timezone: optional string

Timezone the cron expression is evaluated in.

updated_at: optional string

When the schedule was updated.

formatdate-time
ScheduleTriggerByNameResponse object { id, agent_id, initial_input, 20 more }

Response model describing a scheduled agent run.

id: string

The unique identifier of the run schedule.

agent_id: string

The agent this schedule belongs to.

initial_input: object { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author: optional MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type: optional "text"

Input content type.

initial_input_method: string

Delivery method, inferred from the agent’s ACP type.

name: string

Human-readable schedule name.

created_at: optional string

When the schedule was created.

formatdate-time
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }

Credential-free creator identity stored with the schedule.

Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.

account_id: optional string

Account/workspace id of the creator.

principal_type: optional string

e.g. ‘user’ or ‘service_account’.

service_account_id: optional string

Creator service-account id, if a service principal.

user_id: optional string

Creator user id, if a user principal.

cron_expression: optional string

Cron cadence, if cron-based.

description: optional string

Optional description.

end_at: optional string

Schedule deactivation time.

formatdate-time
interval_seconds: optional number

Interval cadence in seconds, if interval-based.

last_action_time: optional string

When the schedule last fired.

formatdate-time
live_data_available: optional boolean

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: optional array of string

Upcoming scheduled fire times.

num_actions_taken: optional number

Number of times the schedule has fired.

paused: optional boolean

Whether the schedule is paused.

skipped_action_times: optional array of string

Skipped one-off scheduled fire times.

start_at: optional string

Schedule activation time.

formatdate-time
state: optional "ACTIVE" or "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata: optional map[unknown]

Task metadata at fire time.

task_params: optional map[unknown]

Task params at fire time.

timezone: optional string

Timezone the cron expression is evaluated in.

updated_at: optional string

When the schedule was updated.

formatdate-time