Skip to content
agentex-sdk
API Reference
Agents

Schedules

Create Run Schedule
client.agents.schedules.create(stringagentID, ScheduleCreateParams { initial_input, name, cron_expression, 8 more } body, RequestOptionsoptions?): ScheduleCreateResponse { id, agent_id, initial_input, 20 more }
POST/agents/{agent_id}/schedules
List Run Schedules
client.agents.schedules.list(stringagentID, ScheduleListParams { include_live, limit } query?, RequestOptionsoptions?): ScheduleListResponse { run_schedules, total }
GET/agents/{agent_id}/schedules
Get Run Schedule
client.agents.schedules.retrieve(stringscheduleID, ScheduleRetrieveParams { agent_id } params, RequestOptionsoptions?): ScheduleRetrieveResponse { id, agent_id, initial_input, 20 more }
GET/agents/{agent_id}/schedules/{schedule_id}
Update Run Schedule
client.agents.schedules.update(stringscheduleID, ScheduleUpdateParams { agent_id, cron_expression, description, 9 more } params, RequestOptionsoptions?): ScheduleUpdateResponse { id, agent_id, initial_input, 20 more }
PATCH/agents/{agent_id}/schedules/{schedule_id}
Delete Run Schedule
client.agents.schedules.delete(stringscheduleID, ScheduleDeleteParams { agent_id } params, RequestOptionsoptions?): DeleteResponse { id, message }
DELETE/agents/{agent_id}/schedules/{schedule_id}
Pause Run Schedule
client.agents.schedules.pause(stringscheduleID, SchedulePauseParams { agent_id, note } params, RequestOptionsoptions?): SchedulePauseResponse { id, agent_id, initial_input, 20 more }
POST/agents/{agent_id}/schedules/{schedule_id}/pause
Resume Run Schedule
client.agents.schedules.resume(stringscheduleID, ScheduleResumeParams { agent_id, note } params, RequestOptionsoptions?): ScheduleResumeResponse { id, agent_id, initial_input, 20 more }
POST/agents/{agent_id}/schedules/{schedule_id}/resume
Trigger Run Schedule
client.agents.schedules.trigger(stringscheduleID, ScheduleTriggerParams { agent_id } params, RequestOptionsoptions?): ScheduleTriggerResponse { id, agent_id, initial_input, 20 more }
POST/agents/{agent_id}/schedules/{schedule_id}/trigger
Skip Run Schedule Action
client.agents.schedules.skip(stringscheduleID, ScheduleSkipParams { agent_id, scheduled_time } params, RequestOptionsoptions?): ScheduleSkipResponse { id, agent_id, initial_input, 20 more }
POST/agents/{agent_id}/schedules/{schedule_id}/skip
Unskip Run Schedule Action
client.agents.schedules.unskip(stringscheduleID, ScheduleUnskipParams { agent_id, scheduled_time } params, RequestOptionsoptions?): ScheduleUnskipResponse { id, agent_id, initial_input, 20 more }
POST/agents/{agent_id}/schedules/{schedule_id}/unskip
Get Run Schedule By Name
client.agents.schedules.retrieveByName(stringname, ScheduleRetrieveByNameParams { agent_id } params, RequestOptionsoptions?): ScheduleRetrieveByNameResponse { id, agent_id, initial_input, 20 more }
GET/agents/{agent_id}/schedules/name/{name}
Update Run Schedule By Name
client.agents.schedules.updateByName(stringname, ScheduleUpdateByNameParams { agent_id, cron_expression, description, 9 more } params, RequestOptionsoptions?): ScheduleUpdateByNameResponse { id, agent_id, initial_input, 20 more }
PATCH/agents/{agent_id}/schedules/name/{name}
Delete Run Schedule By Name
client.agents.schedules.deleteByName(stringname, ScheduleDeleteByNameParams { agent_id } params, RequestOptionsoptions?): DeleteResponse { id, message }
DELETE/agents/{agent_id}/schedules/name/{name}
Pause Run Schedule By Name
client.agents.schedules.pauseByName(stringname, SchedulePauseByNameParams { agent_id, note } params, RequestOptionsoptions?): SchedulePauseByNameResponse { id, agent_id, initial_input, 20 more }
POST/agents/{agent_id}/schedules/name/{name}/pause
Resume Run Schedule By Name
client.agents.schedules.resumeByName(stringname, ScheduleResumeByNameParams { agent_id, note } params, RequestOptionsoptions?): ScheduleResumeByNameResponse { id, agent_id, initial_input, 20 more }
POST/agents/{agent_id}/schedules/name/{name}/resume
Trigger Run Schedule By Name
client.agents.schedules.triggerByName(stringname, ScheduleTriggerByNameParams { agent_id } params, RequestOptionsoptions?): ScheduleTriggerByNameResponse { id, agent_id, initial_input, 20 more }
POST/agents/{agent_id}/schedules/name/{name}/trigger
ModelsExpand Collapse
ScheduleCreateResponse { 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: InitialInput { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author?: MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type?: "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?: string | null

When the schedule was created.

formatdate-time
creator_principal?: CreatorPrincipal | null

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?: string | null

Account/workspace id of the creator.

principal_type?: string | null

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

service_account_id?: string | null

Creator service-account id, if a service principal.

user_id?: string | null

Creator user id, if a user principal.

cron_expression?: string | null

Cron cadence, if cron-based.

description?: string | null

Optional description.

end_at?: string | null

Schedule deactivation time.

formatdate-time
interval_seconds?: number | null

Interval cadence in seconds, if interval-based.

last_action_time?: string | null

When the schedule last fired.

formatdate-time
live_data_available?: boolean | null

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

next_action_times?: Array<string>

Upcoming scheduled fire times.

num_actions_taken?: number

Number of times the schedule has fired.

paused?: boolean

Whether the schedule is paused.

skipped_action_times?: Array<string>

Skipped one-off scheduled fire times.

start_at?: string | null

Schedule activation time.

formatdate-time
state?: "ACTIVE" | "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata?: Record<string, unknown> | null

Task metadata at fire time.

task_params?: Record<string, unknown> | null

Task params at fire time.

timezone?: string

Timezone the cron expression is evaluated in.

updated_at?: string | null

When the schedule was updated.

formatdate-time
ScheduleListResponse { run_schedules, total }

Response model for listing run schedules.

run_schedules: Array<RunSchedule>

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: InitialInput { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author?: MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type?: "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?: string | null

When the schedule was created.

formatdate-time
creator_principal?: CreatorPrincipal | null

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?: string | null

Account/workspace id of the creator.

principal_type?: string | null

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

service_account_id?: string | null

Creator service-account id, if a service principal.

user_id?: string | null

Creator user id, if a user principal.

cron_expression?: string | null

Cron cadence, if cron-based.

description?: string | null

Optional description.

end_at?: string | null

Schedule deactivation time.

formatdate-time
interval_seconds?: number | null

Interval cadence in seconds, if interval-based.

last_action_time?: string | null

When the schedule last fired.

formatdate-time
live_data_available?: boolean | null

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

next_action_times?: Array<string>

Upcoming scheduled fire times.

num_actions_taken?: number

Number of times the schedule has fired.

paused?: boolean

Whether the schedule is paused.

skipped_action_times?: Array<string>

Skipped one-off scheduled fire times.

start_at?: string | null

Schedule activation time.

formatdate-time
state?: "ACTIVE" | "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata?: Record<string, unknown> | null

Task metadata at fire time.

task_params?: Record<string, unknown> | null

Task params at fire time.

timezone?: string

Timezone the cron expression is evaluated in.

updated_at?: string | null

When the schedule was updated.

formatdate-time
total: number

The number of run schedules returned.

ScheduleRetrieveResponse { 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: InitialInput { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author?: MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type?: "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?: string | null

When the schedule was created.

formatdate-time
creator_principal?: CreatorPrincipal | null

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?: string | null

Account/workspace id of the creator.

principal_type?: string | null

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

service_account_id?: string | null

Creator service-account id, if a service principal.

user_id?: string | null

Creator user id, if a user principal.

cron_expression?: string | null

Cron cadence, if cron-based.

description?: string | null

Optional description.

end_at?: string | null

Schedule deactivation time.

formatdate-time
interval_seconds?: number | null

Interval cadence in seconds, if interval-based.

last_action_time?: string | null

When the schedule last fired.

formatdate-time
live_data_available?: boolean | null

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

next_action_times?: Array<string>

Upcoming scheduled fire times.

num_actions_taken?: number

Number of times the schedule has fired.

paused?: boolean

Whether the schedule is paused.

skipped_action_times?: Array<string>

Skipped one-off scheduled fire times.

start_at?: string | null

Schedule activation time.

formatdate-time
state?: "ACTIVE" | "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata?: Record<string, unknown> | null

Task metadata at fire time.

task_params?: Record<string, unknown> | null

Task params at fire time.

timezone?: string

Timezone the cron expression is evaluated in.

updated_at?: string | null

When the schedule was updated.

formatdate-time
ScheduleUpdateResponse { 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: InitialInput { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author?: MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type?: "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?: string | null

When the schedule was created.

formatdate-time
creator_principal?: CreatorPrincipal | null

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?: string | null

Account/workspace id of the creator.

principal_type?: string | null

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

service_account_id?: string | null

Creator service-account id, if a service principal.

user_id?: string | null

Creator user id, if a user principal.

cron_expression?: string | null

Cron cadence, if cron-based.

description?: string | null

Optional description.

end_at?: string | null

Schedule deactivation time.

formatdate-time
interval_seconds?: number | null

Interval cadence in seconds, if interval-based.

last_action_time?: string | null

When the schedule last fired.

formatdate-time
live_data_available?: boolean | null

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

next_action_times?: Array<string>

Upcoming scheduled fire times.

num_actions_taken?: number

Number of times the schedule has fired.

paused?: boolean

Whether the schedule is paused.

skipped_action_times?: Array<string>

Skipped one-off scheduled fire times.

start_at?: string | null

Schedule activation time.

formatdate-time
state?: "ACTIVE" | "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata?: Record<string, unknown> | null

Task metadata at fire time.

task_params?: Record<string, unknown> | null

Task params at fire time.

timezone?: string

Timezone the cron expression is evaluated in.

updated_at?: string | null

When the schedule was updated.

formatdate-time
SchedulePauseResponse { 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: InitialInput { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author?: MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type?: "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?: string | null

When the schedule was created.

formatdate-time
creator_principal?: CreatorPrincipal | null

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?: string | null

Account/workspace id of the creator.

principal_type?: string | null

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

service_account_id?: string | null

Creator service-account id, if a service principal.

user_id?: string | null

Creator user id, if a user principal.

cron_expression?: string | null

Cron cadence, if cron-based.

description?: string | null

Optional description.

end_at?: string | null

Schedule deactivation time.

formatdate-time
interval_seconds?: number | null

Interval cadence in seconds, if interval-based.

last_action_time?: string | null

When the schedule last fired.

formatdate-time
live_data_available?: boolean | null

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

next_action_times?: Array<string>

Upcoming scheduled fire times.

num_actions_taken?: number

Number of times the schedule has fired.

paused?: boolean

Whether the schedule is paused.

skipped_action_times?: Array<string>

Skipped one-off scheduled fire times.

start_at?: string | null

Schedule activation time.

formatdate-time
state?: "ACTIVE" | "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata?: Record<string, unknown> | null

Task metadata at fire time.

task_params?: Record<string, unknown> | null

Task params at fire time.

timezone?: string

Timezone the cron expression is evaluated in.

updated_at?: string | null

When the schedule was updated.

formatdate-time
ScheduleResumeResponse { 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: InitialInput { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author?: MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type?: "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?: string | null

When the schedule was created.

formatdate-time
creator_principal?: CreatorPrincipal | null

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?: string | null

Account/workspace id of the creator.

principal_type?: string | null

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

service_account_id?: string | null

Creator service-account id, if a service principal.

user_id?: string | null

Creator user id, if a user principal.

cron_expression?: string | null

Cron cadence, if cron-based.

description?: string | null

Optional description.

end_at?: string | null

Schedule deactivation time.

formatdate-time
interval_seconds?: number | null

Interval cadence in seconds, if interval-based.

last_action_time?: string | null

When the schedule last fired.

formatdate-time
live_data_available?: boolean | null

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

next_action_times?: Array<string>

Upcoming scheduled fire times.

num_actions_taken?: number

Number of times the schedule has fired.

paused?: boolean

Whether the schedule is paused.

skipped_action_times?: Array<string>

Skipped one-off scheduled fire times.

start_at?: string | null

Schedule activation time.

formatdate-time
state?: "ACTIVE" | "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata?: Record<string, unknown> | null

Task metadata at fire time.

task_params?: Record<string, unknown> | null

Task params at fire time.

timezone?: string

Timezone the cron expression is evaluated in.

updated_at?: string | null

When the schedule was updated.

formatdate-time
ScheduleTriggerResponse { 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: InitialInput { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author?: MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type?: "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?: string | null

When the schedule was created.

formatdate-time
creator_principal?: CreatorPrincipal | null

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?: string | null

Account/workspace id of the creator.

principal_type?: string | null

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

service_account_id?: string | null

Creator service-account id, if a service principal.

user_id?: string | null

Creator user id, if a user principal.

cron_expression?: string | null

Cron cadence, if cron-based.

description?: string | null

Optional description.

end_at?: string | null

Schedule deactivation time.

formatdate-time
interval_seconds?: number | null

Interval cadence in seconds, if interval-based.

last_action_time?: string | null

When the schedule last fired.

formatdate-time
live_data_available?: boolean | null

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

next_action_times?: Array<string>

Upcoming scheduled fire times.

num_actions_taken?: number

Number of times the schedule has fired.

paused?: boolean

Whether the schedule is paused.

skipped_action_times?: Array<string>

Skipped one-off scheduled fire times.

start_at?: string | null

Schedule activation time.

formatdate-time
state?: "ACTIVE" | "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata?: Record<string, unknown> | null

Task metadata at fire time.

task_params?: Record<string, unknown> | null

Task params at fire time.

timezone?: string

Timezone the cron expression is evaluated in.

updated_at?: string | null

When the schedule was updated.

formatdate-time
ScheduleSkipResponse { 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: InitialInput { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author?: MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type?: "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?: string | null

When the schedule was created.

formatdate-time
creator_principal?: CreatorPrincipal | null

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?: string | null

Account/workspace id of the creator.

principal_type?: string | null

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

service_account_id?: string | null

Creator service-account id, if a service principal.

user_id?: string | null

Creator user id, if a user principal.

cron_expression?: string | null

Cron cadence, if cron-based.

description?: string | null

Optional description.

end_at?: string | null

Schedule deactivation time.

formatdate-time
interval_seconds?: number | null

Interval cadence in seconds, if interval-based.

last_action_time?: string | null

When the schedule last fired.

formatdate-time
live_data_available?: boolean | null

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

next_action_times?: Array<string>

Upcoming scheduled fire times.

num_actions_taken?: number

Number of times the schedule has fired.

paused?: boolean

Whether the schedule is paused.

skipped_action_times?: Array<string>

Skipped one-off scheduled fire times.

start_at?: string | null

Schedule activation time.

formatdate-time
state?: "ACTIVE" | "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata?: Record<string, unknown> | null

Task metadata at fire time.

task_params?: Record<string, unknown> | null

Task params at fire time.

timezone?: string

Timezone the cron expression is evaluated in.

updated_at?: string | null

When the schedule was updated.

formatdate-time
ScheduleUnskipResponse { 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: InitialInput { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author?: MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type?: "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?: string | null

When the schedule was created.

formatdate-time
creator_principal?: CreatorPrincipal | null

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?: string | null

Account/workspace id of the creator.

principal_type?: string | null

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

service_account_id?: string | null

Creator service-account id, if a service principal.

user_id?: string | null

Creator user id, if a user principal.

cron_expression?: string | null

Cron cadence, if cron-based.

description?: string | null

Optional description.

end_at?: string | null

Schedule deactivation time.

formatdate-time
interval_seconds?: number | null

Interval cadence in seconds, if interval-based.

last_action_time?: string | null

When the schedule last fired.

formatdate-time
live_data_available?: boolean | null

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

next_action_times?: Array<string>

Upcoming scheduled fire times.

num_actions_taken?: number

Number of times the schedule has fired.

paused?: boolean

Whether the schedule is paused.

skipped_action_times?: Array<string>

Skipped one-off scheduled fire times.

start_at?: string | null

Schedule activation time.

formatdate-time
state?: "ACTIVE" | "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata?: Record<string, unknown> | null

Task metadata at fire time.

task_params?: Record<string, unknown> | null

Task params at fire time.

timezone?: string

Timezone the cron expression is evaluated in.

updated_at?: string | null

When the schedule was updated.

formatdate-time
ScheduleRetrieveByNameResponse { 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: InitialInput { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author?: MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type?: "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?: string | null

When the schedule was created.

formatdate-time
creator_principal?: CreatorPrincipal | null

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?: string | null

Account/workspace id of the creator.

principal_type?: string | null

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

service_account_id?: string | null

Creator service-account id, if a service principal.

user_id?: string | null

Creator user id, if a user principal.

cron_expression?: string | null

Cron cadence, if cron-based.

description?: string | null

Optional description.

end_at?: string | null

Schedule deactivation time.

formatdate-time
interval_seconds?: number | null

Interval cadence in seconds, if interval-based.

last_action_time?: string | null

When the schedule last fired.

formatdate-time
live_data_available?: boolean | null

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

next_action_times?: Array<string>

Upcoming scheduled fire times.

num_actions_taken?: number

Number of times the schedule has fired.

paused?: boolean

Whether the schedule is paused.

skipped_action_times?: Array<string>

Skipped one-off scheduled fire times.

start_at?: string | null

Schedule activation time.

formatdate-time
state?: "ACTIVE" | "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata?: Record<string, unknown> | null

Task metadata at fire time.

task_params?: Record<string, unknown> | null

Task params at fire time.

timezone?: string

Timezone the cron expression is evaluated in.

updated_at?: string | null

When the schedule was updated.

formatdate-time
ScheduleUpdateByNameResponse { 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: InitialInput { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author?: MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type?: "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?: string | null

When the schedule was created.

formatdate-time
creator_principal?: CreatorPrincipal | null

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?: string | null

Account/workspace id of the creator.

principal_type?: string | null

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

service_account_id?: string | null

Creator service-account id, if a service principal.

user_id?: string | null

Creator user id, if a user principal.

cron_expression?: string | null

Cron cadence, if cron-based.

description?: string | null

Optional description.

end_at?: string | null

Schedule deactivation time.

formatdate-time
interval_seconds?: number | null

Interval cadence in seconds, if interval-based.

last_action_time?: string | null

When the schedule last fired.

formatdate-time
live_data_available?: boolean | null

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

next_action_times?: Array<string>

Upcoming scheduled fire times.

num_actions_taken?: number

Number of times the schedule has fired.

paused?: boolean

Whether the schedule is paused.

skipped_action_times?: Array<string>

Skipped one-off scheduled fire times.

start_at?: string | null

Schedule activation time.

formatdate-time
state?: "ACTIVE" | "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata?: Record<string, unknown> | null

Task metadata at fire time.

task_params?: Record<string, unknown> | null

Task params at fire time.

timezone?: string

Timezone the cron expression is evaluated in.

updated_at?: string | null

When the schedule was updated.

formatdate-time
SchedulePauseByNameResponse { 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: InitialInput { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author?: MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type?: "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?: string | null

When the schedule was created.

formatdate-time
creator_principal?: CreatorPrincipal | null

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?: string | null

Account/workspace id of the creator.

principal_type?: string | null

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

service_account_id?: string | null

Creator service-account id, if a service principal.

user_id?: string | null

Creator user id, if a user principal.

cron_expression?: string | null

Cron cadence, if cron-based.

description?: string | null

Optional description.

end_at?: string | null

Schedule deactivation time.

formatdate-time
interval_seconds?: number | null

Interval cadence in seconds, if interval-based.

last_action_time?: string | null

When the schedule last fired.

formatdate-time
live_data_available?: boolean | null

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

next_action_times?: Array<string>

Upcoming scheduled fire times.

num_actions_taken?: number

Number of times the schedule has fired.

paused?: boolean

Whether the schedule is paused.

skipped_action_times?: Array<string>

Skipped one-off scheduled fire times.

start_at?: string | null

Schedule activation time.

formatdate-time
state?: "ACTIVE" | "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata?: Record<string, unknown> | null

Task metadata at fire time.

task_params?: Record<string, unknown> | null

Task params at fire time.

timezone?: string

Timezone the cron expression is evaluated in.

updated_at?: string | null

When the schedule was updated.

formatdate-time
ScheduleResumeByNameResponse { 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: InitialInput { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author?: MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type?: "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?: string | null

When the schedule was created.

formatdate-time
creator_principal?: CreatorPrincipal | null

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?: string | null

Account/workspace id of the creator.

principal_type?: string | null

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

service_account_id?: string | null

Creator service-account id, if a service principal.

user_id?: string | null

Creator user id, if a user principal.

cron_expression?: string | null

Cron cadence, if cron-based.

description?: string | null

Optional description.

end_at?: string | null

Schedule deactivation time.

formatdate-time
interval_seconds?: number | null

Interval cadence in seconds, if interval-based.

last_action_time?: string | null

When the schedule last fired.

formatdate-time
live_data_available?: boolean | null

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

next_action_times?: Array<string>

Upcoming scheduled fire times.

num_actions_taken?: number

Number of times the schedule has fired.

paused?: boolean

Whether the schedule is paused.

skipped_action_times?: Array<string>

Skipped one-off scheduled fire times.

start_at?: string | null

Schedule activation time.

formatdate-time
state?: "ACTIVE" | "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata?: Record<string, unknown> | null

Task metadata at fire time.

task_params?: Record<string, unknown> | null

Task params at fire time.

timezone?: string

Timezone the cron expression is evaluated in.

updated_at?: string | null

When the schedule was updated.

formatdate-time
ScheduleTriggerByNameResponse { 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: InitialInput { content, author, type }

The initial input.

content: string

The initial prompt delivered to the task.

author?: MessageAuthor

The author attributed to the initial input.

One of the following:
"user"
"agent"
type?: "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?: string | null

When the schedule was created.

formatdate-time
creator_principal?: CreatorPrincipal | null

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?: string | null

Account/workspace id of the creator.

principal_type?: string | null

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

service_account_id?: string | null

Creator service-account id, if a service principal.

user_id?: string | null

Creator user id, if a user principal.

cron_expression?: string | null

Cron cadence, if cron-based.

description?: string | null

Optional description.

end_at?: string | null

Schedule deactivation time.

formatdate-time
interval_seconds?: number | null

Interval cadence in seconds, if interval-based.

last_action_time?: string | null

When the schedule last fired.

formatdate-time
live_data_available?: boolean | null

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

next_action_times?: Array<string>

Upcoming scheduled fire times.

num_actions_taken?: number

Number of times the schedule has fired.

paused?: boolean

Whether the schedule is paused.

skipped_action_times?: Array<string>

Skipped one-off scheduled fire times.

start_at?: string | null

Schedule activation time.

formatdate-time
state?: "ACTIVE" | "PAUSED"

Live schedule state from Temporal.

One of the following:
"ACTIVE"
"PAUSED"
task_metadata?: Record<string, unknown> | null

Task metadata at fire time.

task_params?: Record<string, unknown> | null

Task params at fire time.

timezone?: string

Timezone the cron expression is evaluated in.

updated_at?: string | null

When the schedule was updated.

formatdate-time