API Reference

Agents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Schedules

Create Run Schedule

agents.schedules.create(stragent_id, ScheduleCreateParams**kwargs) -> ScheduleCreateResponse

POST/agents/{agent_id}/schedules

List Run Schedules

agents.schedules.list(stragent_id, ScheduleListParams**kwargs) -> ScheduleListResponse

GET/agents/{agent_id}/schedules

Get Run Schedule

agents.schedules.retrieve(strschedule_id, ScheduleRetrieveParams**kwargs) -> ScheduleRetrieveResponse

GET/agents/{agent_id}/schedules/{schedule_id}

Update Run Schedule

agents.schedules.update(strschedule_id, ScheduleUpdateParams**kwargs) -> ScheduleUpdateResponse

PATCH/agents/{agent_id}/schedules/{schedule_id}

Delete Run Schedule

agents.schedules.delete(strschedule_id, ScheduleDeleteParams**kwargs) -> DeleteResponse

DELETE/agents/{agent_id}/schedules/{schedule_id}

Pause Run Schedule

agents.schedules.pause(strschedule_id, SchedulePauseParams**kwargs) -> SchedulePauseResponse

POST/agents/{agent_id}/schedules/{schedule_id}/pause

Resume Run Schedule

agents.schedules.resume(strschedule_id, ScheduleResumeParams**kwargs) -> ScheduleResumeResponse

POST/agents/{agent_id}/schedules/{schedule_id}/resume

Trigger Run Schedule

agents.schedules.trigger(strschedule_id, ScheduleTriggerParams**kwargs) -> ScheduleTriggerResponse

POST/agents/{agent_id}/schedules/{schedule_id}/trigger

Skip Run Schedule Action

agents.schedules.skip(strschedule_id, ScheduleSkipParams**kwargs) -> ScheduleSkipResponse

POST/agents/{agent_id}/schedules/{schedule_id}/skip

Unskip Run Schedule Action

agents.schedules.unskip(strschedule_id, ScheduleUnskipParams**kwargs) -> ScheduleUnskipResponse

POST/agents/{agent_id}/schedules/{schedule_id}/unskip

Get Run Schedule By Name

agents.schedules.retrieve_by_name(strname, ScheduleRetrieveByNameParams**kwargs) -> ScheduleRetrieveByNameResponse

GET/agents/{agent_id}/schedules/name/{name}

Update Run Schedule By Name

agents.schedules.update_by_name(strpath_name, ScheduleUpdateByNameParams**kwargs) -> ScheduleUpdateByNameResponse

PATCH/agents/{agent_id}/schedules/name/{name}

Delete Run Schedule By Name

agents.schedules.delete_by_name(strname, ScheduleDeleteByNameParams**kwargs) -> DeleteResponse

DELETE/agents/{agent_id}/schedules/name/{name}

Pause Run Schedule By Name

agents.schedules.pause_by_name(strname, SchedulePauseByNameParams**kwargs) -> SchedulePauseByNameResponse

POST/agents/{agent_id}/schedules/name/{name}/pause

Resume Run Schedule By Name

agents.schedules.resume_by_name(strname, ScheduleResumeByNameParams**kwargs) -> ScheduleResumeByNameResponse

POST/agents/{agent_id}/schedules/name/{name}/resume

Trigger Run Schedule By Name

agents.schedules.trigger_by_name(strname, ScheduleTriggerByNameParams**kwargs) -> ScheduleTriggerByNameResponse

POST/agents/{agent_id}/schedules/name/{name}/trigger

ModelsExpand Collapse

class ScheduleCreateResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

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[Literal["text"]]

Input content type.

initial_input_method: str

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

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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[str]

Account/workspace id of the creator.

principal_type: Optional[str]

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

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

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

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleListResponse: …

Response model for listing run schedules.

run_schedules: List[RunSchedule]

The list of run schedules.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: RunScheduleInitialInput

The initial input.

content: str

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[Literal["text"]]

Input content type.

initial_input_method: str

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

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[RunScheduleCreatorPrincipal]

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[str]

Account/workspace id of the creator.

principal_type: Optional[str]

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

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

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

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

total: int

The number of run schedules returned.

class ScheduleRetrieveResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

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[Literal["text"]]

Input content type.

initial_input_method: str

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

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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[str]

Account/workspace id of the creator.

principal_type: Optional[str]

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

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

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

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleUpdateResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

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[Literal["text"]]

Input content type.

initial_input_method: str

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

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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[str]

Account/workspace id of the creator.

principal_type: Optional[str]

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

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

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

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class SchedulePauseResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

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[Literal["text"]]

Input content type.

initial_input_method: str

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

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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[str]

Account/workspace id of the creator.

principal_type: Optional[str]

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

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

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

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleResumeResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

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[Literal["text"]]

Input content type.

initial_input_method: str

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

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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[str]

Account/workspace id of the creator.

principal_type: Optional[str]

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

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

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

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleTriggerResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

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[Literal["text"]]

Input content type.

initial_input_method: str

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

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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[str]

Account/workspace id of the creator.

principal_type: Optional[str]

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

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

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

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleSkipResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

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[Literal["text"]]

Input content type.

initial_input_method: str

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

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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[str]

Account/workspace id of the creator.

principal_type: Optional[str]

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

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

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

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleUnskipResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

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[Literal["text"]]

Input content type.

initial_input_method: str

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

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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[str]

Account/workspace id of the creator.

principal_type: Optional[str]

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

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

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

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleRetrieveByNameResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

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[Literal["text"]]

Input content type.

initial_input_method: str

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

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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[str]

Account/workspace id of the creator.

principal_type: Optional[str]

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

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

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

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleUpdateByNameResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

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[Literal["text"]]

Input content type.

initial_input_method: str

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

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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[str]

Account/workspace id of the creator.

principal_type: Optional[str]

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

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

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

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class SchedulePauseByNameResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

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[Literal["text"]]

Input content type.

initial_input_method: str

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

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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[str]

Account/workspace id of the creator.

principal_type: Optional[str]

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

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

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

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleResumeByNameResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

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[Literal["text"]]

Input content type.

initial_input_method: str

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

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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[str]

Account/workspace id of the creator.

principal_type: Optional[str]

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

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

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

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleTriggerByNameResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

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[Literal["text"]]

Input content type.

initial_input_method: str

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

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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[str]

Account/workspace id of the creator.

principal_type: Optional[str]

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

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

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

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time