# Schedules ## Create Run Schedule `agents.schedules.create(stragent_id, ScheduleCreateParams**kwargs) -> ScheduleCreateResponse` **post** `/agents/{agent_id}/schedules` Create a recurring schedule that starts a fresh agent run on each fire. ### Parameters - `agent_id: str` - `initial_input: InitialInput` The first input delivered to each created task. - `content: str` The initial prompt delivered to the task. - `author: Optional[MessageAuthor]` The author attributed to the initial input. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `name: str` Human-readable name, unique among active schedules for the agent. - `cron_expression: Optional[str]` Cron expression for the cadence (e.g. '0 17 * * MON-FRI'). Mutually exclusive with interval_seconds. - `description: Optional[str]` Optional description of what this schedule does. - `end_at: Optional[Union[str, datetime, null]]` When the schedule should stop being active. - `interval_seconds: Optional[int]` Interval cadence in seconds. Mutually exclusive with cron_expression. - `paused: Optional[bool]` Whether to create the schedule in a paused state. - `start_at: Optional[Union[str, datetime, null]]` When the schedule should start being active. - `task_metadata: Optional[Dict[str, object]]` Metadata copied onto each created task at fire time. - `task_params: Optional[Dict[str, object]]` Resolved config forwarded as task `params` at fire time. - `timezone: Optional[str]` IANA timezone the cron expression is evaluated in (e.g. 'America/New_York'). ### Returns - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Example ```python import os from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) schedule = client.agents.schedules.create( agent_id="agent_id", initial_input={ "content": "content" }, name="name", ) print(schedule.id) ``` #### Response ```json { "id": "id", "agent_id": "agent_id", "initial_input": { "content": "content", "author": "user", "type": "text" }, "initial_input_method": "initial_input_method", "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "creator_principal": { "account_id": "account_id", "principal_type": "principal_type", "service_account_id": "service_account_id", "user_id": "user_id" }, "cron_expression": "cron_expression", "description": "description", "end_at": "2019-12-27T18:11:19.117Z", "interval_seconds": 0, "last_action_time": "2019-12-27T18:11:19.117Z", "live_data_available": true, "next_action_times": [ "2019-12-27T18:11:19.117Z" ], "num_actions_taken": 0, "paused": true, "skipped_action_times": [ "2019-12-27T18:11:19.117Z" ], "start_at": "2019-12-27T18:11:19.117Z", "state": "ACTIVE", "task_metadata": { "foo": "bar" }, "task_params": { "foo": "bar" }, "timezone": "timezone", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## List Run Schedules `agents.schedules.list(stragent_id, ScheduleListParams**kwargs) -> ScheduleListResponse` **get** `/agents/{agent_id}/schedules` List run schedules for an agent. ### Parameters - `agent_id: str` - `include_live: Optional[bool]` Include live Temporal state and upcoming action times. - `limit: Optional[int]` ### Returns - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. - `total: int` The number of run schedules returned. ### Example ```python import os from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) schedules = client.agents.schedules.list( agent_id="agent_id", ) print(schedules.run_schedules) ``` #### Response ```json { "run_schedules": [ { "id": "id", "agent_id": "agent_id", "initial_input": { "content": "content", "author": "user", "type": "text" }, "initial_input_method": "initial_input_method", "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "creator_principal": { "account_id": "account_id", "principal_type": "principal_type", "service_account_id": "service_account_id", "user_id": "user_id" }, "cron_expression": "cron_expression", "description": "description", "end_at": "2019-12-27T18:11:19.117Z", "interval_seconds": 0, "last_action_time": "2019-12-27T18:11:19.117Z", "live_data_available": true, "next_action_times": [ "2019-12-27T18:11:19.117Z" ], "num_actions_taken": 0, "paused": true, "skipped_action_times": [ "2019-12-27T18:11:19.117Z" ], "start_at": "2019-12-27T18:11:19.117Z", "state": "ACTIVE", "task_metadata": { "foo": "bar" }, "task_params": { "foo": "bar" }, "timezone": "timezone", "updated_at": "2019-12-27T18:11:19.117Z" } ], "total": 0 } ``` ## Get Run Schedule `agents.schedules.retrieve(strschedule_id, ScheduleRetrieveParams**kwargs) -> ScheduleRetrieveResponse` **get** `/agents/{agent_id}/schedules/{schedule_id}` Get a run schedule by its id. ### Parameters - `agent_id: str` - `schedule_id: str` ### Returns - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Example ```python import os from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) schedule = client.agents.schedules.retrieve( schedule_id="schedule_id", agent_id="agent_id", ) print(schedule.id) ``` #### Response ```json { "id": "id", "agent_id": "agent_id", "initial_input": { "content": "content", "author": "user", "type": "text" }, "initial_input_method": "initial_input_method", "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "creator_principal": { "account_id": "account_id", "principal_type": "principal_type", "service_account_id": "service_account_id", "user_id": "user_id" }, "cron_expression": "cron_expression", "description": "description", "end_at": "2019-12-27T18:11:19.117Z", "interval_seconds": 0, "last_action_time": "2019-12-27T18:11:19.117Z", "live_data_available": true, "next_action_times": [ "2019-12-27T18:11:19.117Z" ], "num_actions_taken": 0, "paused": true, "skipped_action_times": [ "2019-12-27T18:11:19.117Z" ], "start_at": "2019-12-27T18:11:19.117Z", "state": "ACTIVE", "task_metadata": { "foo": "bar" }, "task_params": { "foo": "bar" }, "timezone": "timezone", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Update Run Schedule `agents.schedules.update(strschedule_id, ScheduleUpdateParams**kwargs) -> ScheduleUpdateResponse` **patch** `/agents/{agent_id}/schedules/{schedule_id}` Partially update a run schedule's definition (cadence, window, input, etc.). ### Parameters - `agent_id: str` - `schedule_id: str` - `cron_expression: Optional[str]` New cron cadence. Mutually exclusive with interval_seconds. - `description: Optional[str]` Optional description of what this schedule does. - `end_at: Optional[Union[str, datetime, null]]` When the schedule should stop being active. - `initial_input: Optional[InitialInput]` The first input delivered to each freshly created scheduled task. - `content: str` The initial prompt delivered to the task. - `author: Optional[MessageAuthor]` The author attributed to the initial input. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `interval_seconds: Optional[int]` New interval cadence in seconds. Mutually exclusive with cron_expression. - `name: Optional[str]` Human-readable name, unique among active schedules for the agent. - `paused: Optional[bool]` Pause/resume the schedule as part of the update. - `start_at: Optional[Union[str, datetime, null]]` When the schedule should start being active. - `task_metadata: Optional[Dict[str, object]]` Metadata copied onto each created task at fire time. - `task_params: Optional[Dict[str, object]]` Resolved config forwarded as task `params` at fire time. - `timezone: Optional[str]` IANA timezone the cron expression is evaluated in. ### Returns - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Example ```python import os from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) schedule = client.agents.schedules.update( schedule_id="schedule_id", agent_id="agent_id", ) print(schedule.id) ``` #### Response ```json { "id": "id", "agent_id": "agent_id", "initial_input": { "content": "content", "author": "user", "type": "text" }, "initial_input_method": "initial_input_method", "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "creator_principal": { "account_id": "account_id", "principal_type": "principal_type", "service_account_id": "service_account_id", "user_id": "user_id" }, "cron_expression": "cron_expression", "description": "description", "end_at": "2019-12-27T18:11:19.117Z", "interval_seconds": 0, "last_action_time": "2019-12-27T18:11:19.117Z", "live_data_available": true, "next_action_times": [ "2019-12-27T18:11:19.117Z" ], "num_actions_taken": 0, "paused": true, "skipped_action_times": [ "2019-12-27T18:11:19.117Z" ], "start_at": "2019-12-27T18:11:19.117Z", "state": "ACTIVE", "task_metadata": { "foo": "bar" }, "task_params": { "foo": "bar" }, "timezone": "timezone", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Delete Run Schedule `agents.schedules.delete(strschedule_id, ScheduleDeleteParams**kwargs) -> DeleteResponse` **delete** `/agents/{agent_id}/schedules/{schedule_id}` Delete a run schedule permanently. ### Parameters - `agent_id: str` - `schedule_id: str` ### Returns - `class DeleteResponse: …` - `id: str` - `message: str` ### Example ```python import os from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) delete_response = client.agents.schedules.delete( schedule_id="schedule_id", agent_id="agent_id", ) print(delete_response.id) ``` #### Response ```json { "id": "id", "message": "message" } ``` ## Pause Run Schedule `agents.schedules.pause(strschedule_id, SchedulePauseParams**kwargs) -> SchedulePauseResponse` **post** `/agents/{agent_id}/schedules/{schedule_id}/pause` Pause a run schedule so it stops firing. ### Parameters - `agent_id: str` - `schedule_id: str` - `note: Optional[str]` Optional note explaining the pause. ### Returns - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Example ```python import os from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) response = client.agents.schedules.pause( schedule_id="schedule_id", agent_id="agent_id", ) print(response.id) ``` #### Response ```json { "id": "id", "agent_id": "agent_id", "initial_input": { "content": "content", "author": "user", "type": "text" }, "initial_input_method": "initial_input_method", "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "creator_principal": { "account_id": "account_id", "principal_type": "principal_type", "service_account_id": "service_account_id", "user_id": "user_id" }, "cron_expression": "cron_expression", "description": "description", "end_at": "2019-12-27T18:11:19.117Z", "interval_seconds": 0, "last_action_time": "2019-12-27T18:11:19.117Z", "live_data_available": true, "next_action_times": [ "2019-12-27T18:11:19.117Z" ], "num_actions_taken": 0, "paused": true, "skipped_action_times": [ "2019-12-27T18:11:19.117Z" ], "start_at": "2019-12-27T18:11:19.117Z", "state": "ACTIVE", "task_metadata": { "foo": "bar" }, "task_params": { "foo": "bar" }, "timezone": "timezone", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Resume Run Schedule `agents.schedules.resume(strschedule_id, ScheduleResumeParams**kwargs) -> ScheduleResumeResponse` **post** `/agents/{agent_id}/schedules/{schedule_id}/resume` Resume a paused run schedule so it fires again. ### Parameters - `agent_id: str` - `schedule_id: str` - `note: Optional[str]` Optional note explaining the resume. ### Returns - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Example ```python import os from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) response = client.agents.schedules.resume( schedule_id="schedule_id", agent_id="agent_id", ) print(response.id) ``` #### Response ```json { "id": "id", "agent_id": "agent_id", "initial_input": { "content": "content", "author": "user", "type": "text" }, "initial_input_method": "initial_input_method", "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "creator_principal": { "account_id": "account_id", "principal_type": "principal_type", "service_account_id": "service_account_id", "user_id": "user_id" }, "cron_expression": "cron_expression", "description": "description", "end_at": "2019-12-27T18:11:19.117Z", "interval_seconds": 0, "last_action_time": "2019-12-27T18:11:19.117Z", "live_data_available": true, "next_action_times": [ "2019-12-27T18:11:19.117Z" ], "num_actions_taken": 0, "paused": true, "skipped_action_times": [ "2019-12-27T18:11:19.117Z" ], "start_at": "2019-12-27T18:11:19.117Z", "state": "ACTIVE", "task_metadata": { "foo": "bar" }, "task_params": { "foo": "bar" }, "timezone": "timezone", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Trigger Run Schedule `agents.schedules.trigger(strschedule_id, ScheduleTriggerParams**kwargs) -> ScheduleTriggerResponse` **post** `/agents/{agent_id}/schedules/{schedule_id}/trigger` Trigger an immediate, out-of-band run of the schedule (in addition to its cadence). ### Parameters - `agent_id: str` - `schedule_id: str` ### Returns - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Example ```python import os from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) response = client.agents.schedules.trigger( schedule_id="schedule_id", agent_id="agent_id", ) print(response.id) ``` #### Response ```json { "id": "id", "agent_id": "agent_id", "initial_input": { "content": "content", "author": "user", "type": "text" }, "initial_input_method": "initial_input_method", "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "creator_principal": { "account_id": "account_id", "principal_type": "principal_type", "service_account_id": "service_account_id", "user_id": "user_id" }, "cron_expression": "cron_expression", "description": "description", "end_at": "2019-12-27T18:11:19.117Z", "interval_seconds": 0, "last_action_time": "2019-12-27T18:11:19.117Z", "live_data_available": true, "next_action_times": [ "2019-12-27T18:11:19.117Z" ], "num_actions_taken": 0, "paused": true, "skipped_action_times": [ "2019-12-27T18:11:19.117Z" ], "start_at": "2019-12-27T18:11:19.117Z", "state": "ACTIVE", "task_metadata": { "foo": "bar" }, "task_params": { "foo": "bar" }, "timezone": "timezone", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Skip Run Schedule Action `agents.schedules.skip(strschedule_id, ScheduleSkipParams**kwargs) -> ScheduleSkipResponse` **post** `/agents/{agent_id}/schedules/{schedule_id}/skip` Skip a recurring fire of the schedule. ### Parameters - `agent_id: str` - `schedule_id: str` - `scheduled_time: Union[str, datetime]` Specific scheduled fire time to skip. ### Returns - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Example ```python import os from datetime import datetime from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) response = client.agents.schedules.skip( schedule_id="schedule_id", agent_id="agent_id", scheduled_time=datetime.fromisoformat("2019-12-27T18:11:19.117"), ) print(response.id) ``` #### Response ```json { "id": "id", "agent_id": "agent_id", "initial_input": { "content": "content", "author": "user", "type": "text" }, "initial_input_method": "initial_input_method", "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "creator_principal": { "account_id": "account_id", "principal_type": "principal_type", "service_account_id": "service_account_id", "user_id": "user_id" }, "cron_expression": "cron_expression", "description": "description", "end_at": "2019-12-27T18:11:19.117Z", "interval_seconds": 0, "last_action_time": "2019-12-27T18:11:19.117Z", "live_data_available": true, "next_action_times": [ "2019-12-27T18:11:19.117Z" ], "num_actions_taken": 0, "paused": true, "skipped_action_times": [ "2019-12-27T18:11:19.117Z" ], "start_at": "2019-12-27T18:11:19.117Z", "state": "ACTIVE", "task_metadata": { "foo": "bar" }, "task_params": { "foo": "bar" }, "timezone": "timezone", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Unskip Run Schedule Action `agents.schedules.unskip(strschedule_id, ScheduleUnskipParams**kwargs) -> ScheduleUnskipResponse` **post** `/agents/{agent_id}/schedules/{schedule_id}/unskip` Remove a skip for a recurring fire of the schedule. ### Parameters - `agent_id: str` - `schedule_id: str` - `scheduled_time: Union[str, datetime]` Specific scheduled fire time to unskip. ### Returns - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Example ```python import os from datetime import datetime from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) response = client.agents.schedules.unskip( schedule_id="schedule_id", agent_id="agent_id", scheduled_time=datetime.fromisoformat("2019-12-27T18:11:19.117"), ) print(response.id) ``` #### Response ```json { "id": "id", "agent_id": "agent_id", "initial_input": { "content": "content", "author": "user", "type": "text" }, "initial_input_method": "initial_input_method", "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "creator_principal": { "account_id": "account_id", "principal_type": "principal_type", "service_account_id": "service_account_id", "user_id": "user_id" }, "cron_expression": "cron_expression", "description": "description", "end_at": "2019-12-27T18:11:19.117Z", "interval_seconds": 0, "last_action_time": "2019-12-27T18:11:19.117Z", "live_data_available": true, "next_action_times": [ "2019-12-27T18:11:19.117Z" ], "num_actions_taken": 0, "paused": true, "skipped_action_times": [ "2019-12-27T18:11:19.117Z" ], "start_at": "2019-12-27T18:11:19.117Z", "state": "ACTIVE", "task_metadata": { "foo": "bar" }, "task_params": { "foo": "bar" }, "timezone": "timezone", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Get Run Schedule By Name `agents.schedules.retrieve_by_name(strname, ScheduleRetrieveByNameParams**kwargs) -> ScheduleRetrieveByNameResponse` **get** `/agents/{agent_id}/schedules/name/{name}` Get a run schedule by its active name. ### Parameters - `agent_id: str` - `name: str` ### Returns - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Example ```python import os from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) response = client.agents.schedules.retrieve_by_name( name="name", agent_id="agent_id", ) print(response.id) ``` #### Response ```json { "id": "id", "agent_id": "agent_id", "initial_input": { "content": "content", "author": "user", "type": "text" }, "initial_input_method": "initial_input_method", "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "creator_principal": { "account_id": "account_id", "principal_type": "principal_type", "service_account_id": "service_account_id", "user_id": "user_id" }, "cron_expression": "cron_expression", "description": "description", "end_at": "2019-12-27T18:11:19.117Z", "interval_seconds": 0, "last_action_time": "2019-12-27T18:11:19.117Z", "live_data_available": true, "next_action_times": [ "2019-12-27T18:11:19.117Z" ], "num_actions_taken": 0, "paused": true, "skipped_action_times": [ "2019-12-27T18:11:19.117Z" ], "start_at": "2019-12-27T18:11:19.117Z", "state": "ACTIVE", "task_metadata": { "foo": "bar" }, "task_params": { "foo": "bar" }, "timezone": "timezone", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Update Run Schedule By Name `agents.schedules.update_by_name(strpath_name, ScheduleUpdateByNameParams**kwargs) -> ScheduleUpdateByNameResponse` **patch** `/agents/{agent_id}/schedules/name/{name}` Partially update a run schedule's definition by its active name. ### Parameters - `agent_id: str` - `name: str` - `cron_expression: Optional[str]` New cron cadence. Mutually exclusive with interval_seconds. - `description: Optional[str]` Optional description of what this schedule does. - `end_at: Optional[Union[str, datetime, null]]` When the schedule should stop being active. - `initial_input: Optional[InitialInput]` The first input delivered to each freshly created scheduled task. - `content: str` The initial prompt delivered to the task. - `author: Optional[MessageAuthor]` The author attributed to the initial input. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `interval_seconds: Optional[int]` New interval cadence in seconds. Mutually exclusive with cron_expression. - `name: str` - `paused: Optional[bool]` Pause/resume the schedule as part of the update. - `start_at: Optional[Union[str, datetime, null]]` When the schedule should start being active. - `task_metadata: Optional[Dict[str, object]]` Metadata copied onto each created task at fire time. - `task_params: Optional[Dict[str, object]]` Resolved config forwarded as task `params` at fire time. - `timezone: Optional[str]` IANA timezone the cron expression is evaluated in. ### Returns - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Example ```python import os from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) response = client.agents.schedules.update_by_name( path_name="name", agent_id="agent_id", ) print(response.id) ``` #### Response ```json { "id": "id", "agent_id": "agent_id", "initial_input": { "content": "content", "author": "user", "type": "text" }, "initial_input_method": "initial_input_method", "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "creator_principal": { "account_id": "account_id", "principal_type": "principal_type", "service_account_id": "service_account_id", "user_id": "user_id" }, "cron_expression": "cron_expression", "description": "description", "end_at": "2019-12-27T18:11:19.117Z", "interval_seconds": 0, "last_action_time": "2019-12-27T18:11:19.117Z", "live_data_available": true, "next_action_times": [ "2019-12-27T18:11:19.117Z" ], "num_actions_taken": 0, "paused": true, "skipped_action_times": [ "2019-12-27T18:11:19.117Z" ], "start_at": "2019-12-27T18:11:19.117Z", "state": "ACTIVE", "task_metadata": { "foo": "bar" }, "task_params": { "foo": "bar" }, "timezone": "timezone", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Delete Run Schedule By Name `agents.schedules.delete_by_name(strname, ScheduleDeleteByNameParams**kwargs) -> DeleteResponse` **delete** `/agents/{agent_id}/schedules/name/{name}` Delete a run schedule by its active name. ### Parameters - `agent_id: str` - `name: str` ### Returns - `class DeleteResponse: …` - `id: str` - `message: str` ### Example ```python import os from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) delete_response = client.agents.schedules.delete_by_name( name="name", agent_id="agent_id", ) print(delete_response.id) ``` #### Response ```json { "id": "id", "message": "message" } ``` ## Pause Run Schedule By Name `agents.schedules.pause_by_name(strname, SchedulePauseByNameParams**kwargs) -> SchedulePauseByNameResponse` **post** `/agents/{agent_id}/schedules/name/{name}/pause` Pause a run schedule by its active name. ### Parameters - `agent_id: str` - `name: str` - `note: Optional[str]` Optional note explaining the pause. ### Returns - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Example ```python import os from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) response = client.agents.schedules.pause_by_name( name="name", agent_id="agent_id", ) print(response.id) ``` #### Response ```json { "id": "id", "agent_id": "agent_id", "initial_input": { "content": "content", "author": "user", "type": "text" }, "initial_input_method": "initial_input_method", "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "creator_principal": { "account_id": "account_id", "principal_type": "principal_type", "service_account_id": "service_account_id", "user_id": "user_id" }, "cron_expression": "cron_expression", "description": "description", "end_at": "2019-12-27T18:11:19.117Z", "interval_seconds": 0, "last_action_time": "2019-12-27T18:11:19.117Z", "live_data_available": true, "next_action_times": [ "2019-12-27T18:11:19.117Z" ], "num_actions_taken": 0, "paused": true, "skipped_action_times": [ "2019-12-27T18:11:19.117Z" ], "start_at": "2019-12-27T18:11:19.117Z", "state": "ACTIVE", "task_metadata": { "foo": "bar" }, "task_params": { "foo": "bar" }, "timezone": "timezone", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Resume Run Schedule By Name `agents.schedules.resume_by_name(strname, ScheduleResumeByNameParams**kwargs) -> ScheduleResumeByNameResponse` **post** `/agents/{agent_id}/schedules/name/{name}/resume` Resume a paused run schedule by its active name. ### Parameters - `agent_id: str` - `name: str` - `note: Optional[str]` Optional note explaining the resume. ### Returns - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Example ```python import os from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) response = client.agents.schedules.resume_by_name( name="name", agent_id="agent_id", ) print(response.id) ``` #### Response ```json { "id": "id", "agent_id": "agent_id", "initial_input": { "content": "content", "author": "user", "type": "text" }, "initial_input_method": "initial_input_method", "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "creator_principal": { "account_id": "account_id", "principal_type": "principal_type", "service_account_id": "service_account_id", "user_id": "user_id" }, "cron_expression": "cron_expression", "description": "description", "end_at": "2019-12-27T18:11:19.117Z", "interval_seconds": 0, "last_action_time": "2019-12-27T18:11:19.117Z", "live_data_available": true, "next_action_times": [ "2019-12-27T18:11:19.117Z" ], "num_actions_taken": 0, "paused": true, "skipped_action_times": [ "2019-12-27T18:11:19.117Z" ], "start_at": "2019-12-27T18:11:19.117Z", "state": "ACTIVE", "task_metadata": { "foo": "bar" }, "task_params": { "foo": "bar" }, "timezone": "timezone", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Trigger Run Schedule By Name `agents.schedules.trigger_by_name(strname, ScheduleTriggerByNameParams**kwargs) -> ScheduleTriggerByNameResponse` **post** `/agents/{agent_id}/schedules/name/{name}/trigger` Trigger an immediate, out-of-band run of the schedule by its active name. ### Parameters - `agent_id: str` - `name: str` ### Returns - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Example ```python import os from agentex import Agentex client = Agentex( api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted ) response = client.agents.schedules.trigger_by_name( name="name", agent_id="agent_id", ) print(response.id) ``` #### Response ```json { "id": "id", "agent_id": "agent_id", "initial_input": { "content": "content", "author": "user", "type": "text" }, "initial_input_method": "initial_input_method", "name": "name", "created_at": "2019-12-27T18:11:19.117Z", "creator_principal": { "account_id": "account_id", "principal_type": "principal_type", "service_account_id": "service_account_id", "user_id": "user_id" }, "cron_expression": "cron_expression", "description": "description", "end_at": "2019-12-27T18:11:19.117Z", "interval_seconds": 0, "last_action_time": "2019-12-27T18:11:19.117Z", "live_data_available": true, "next_action_times": [ "2019-12-27T18:11:19.117Z" ], "num_actions_taken": 0, "paused": true, "skipped_action_times": [ "2019-12-27T18:11:19.117Z" ], "start_at": "2019-12-27T18:11:19.117Z", "state": "ACTIVE", "task_metadata": { "foo": "bar" }, "task_params": { "foo": "bar" }, "timezone": "timezone", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Domain Types ### Schedule Create Response - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Schedule List Response - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. - `total: int` The number of run schedules returned. ### Schedule Retrieve Response - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Schedule Update Response - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Schedule Pause Response - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Schedule Resume Response - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Schedule Trigger Response - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Schedule Skip Response - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Schedule Unskip Response - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Schedule Retrieve By Name Response - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Schedule Update By Name Response - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Schedule Pause By Name Response - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Schedule Resume By Name Response - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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. ### Schedule Trigger By Name Response - `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. - `"user"` - `"agent"` - `type: Optional[Literal["text"]]` Input content type. - `"text"` - `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. - `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. - `interval_seconds: Optional[int]` Interval cadence in seconds, if interval-based. - `last_action_time: Optional[datetime]` When the schedule last fired. - `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. - `state: Optional[Literal["ACTIVE", "PAUSED"]]` Live schedule state from Temporal. - `"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.