# Schedules ## Create Run Schedule `client.agents.schedules.create(stringagentID, ScheduleCreateParamsbody, RequestOptionsoptions?): ScheduleCreateResponse` **post** `/agents/{agent_id}/schedules` Create a recurring schedule that starts a fresh agent run on each fire. ### Parameters - `agentID: string` - `body: ScheduleCreateParams` - `initial_input: InitialInput` The first input delivered to each created task. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `name: string` Human-readable name, unique among active schedules for the agent. - `cron_expression?: string | null` Cron expression for the cadence (e.g. '0 17 * * MON-FRI'). Mutually exclusive with interval_seconds. - `description?: string | null` Optional description of what this schedule does. - `end_at?: string | null` When the schedule should stop being active. - `interval_seconds?: number | null` Interval cadence in seconds. Mutually exclusive with cron_expression. - `paused?: boolean` Whether to create the schedule in a paused state. - `start_at?: string | null` When the schedule should start being active. - `task_metadata?: Record | null` Metadata copied onto each created task at fire time. - `task_params?: Record | null` Resolved config forwarded as task `params` at fire time. - `timezone?: string` IANA timezone the cron expression is evaluated in (e.g. 'America/New_York'). ### Returns - `ScheduleCreateResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const schedule = await client.agents.schedules.create('agent_id', { initial_input: { content: 'content' }, name: 'name', }); console.log(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 `client.agents.schedules.list(stringagentID, ScheduleListParamsquery?, RequestOptionsoptions?): ScheduleListResponse` **get** `/agents/{agent_id}/schedules` List run schedules for an agent. ### Parameters - `agentID: string` - `query: ScheduleListParams` - `include_live?: boolean` Include live Temporal state and upcoming action times. - `limit?: number` ### Returns - `ScheduleListResponse` Response model for listing run schedules. - `run_schedules: Array` The list of run schedules. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. - `total: number` The number of run schedules returned. ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const schedules = await client.agents.schedules.list('agent_id'); console.log(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 `client.agents.schedules.retrieve(stringscheduleID, ScheduleRetrieveParamsparams, RequestOptionsoptions?): ScheduleRetrieveResponse` **get** `/agents/{agent_id}/schedules/{schedule_id}` Get a run schedule by its id. ### Parameters - `scheduleID: string` - `params: ScheduleRetrieveParams` - `agent_id: string` ### Returns - `ScheduleRetrieveResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const schedule = await client.agents.schedules.retrieve('schedule_id', { agent_id: 'agent_id' }); console.log(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 `client.agents.schedules.update(stringscheduleID, ScheduleUpdateParamsparams, RequestOptionsoptions?): ScheduleUpdateResponse` **patch** `/agents/{agent_id}/schedules/{schedule_id}` Partially update a run schedule's definition (cadence, window, input, etc.). ### Parameters - `scheduleID: string` - `params: ScheduleUpdateParams` - `agent_id: string` Path param - `cron_expression?: string | null` Body param: New cron cadence. Mutually exclusive with interval_seconds. - `description?: string | null` Body param: Optional description of what this schedule does. - `end_at?: string | null` Body param: When the schedule should stop being active. - `initial_input?: InitialInput | null` Body param: The first input delivered to each freshly created scheduled task. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `interval_seconds?: number | null` Body param: New interval cadence in seconds. Mutually exclusive with cron_expression. - `name?: string | null` Body param: Human-readable name, unique among active schedules for the agent. - `paused?: boolean | null` Body param: Pause/resume the schedule as part of the update. - `start_at?: string | null` Body param: When the schedule should start being active. - `task_metadata?: Record | null` Body param: Metadata copied onto each created task at fire time. - `task_params?: Record | null` Body param: Resolved config forwarded as task `params` at fire time. - `timezone?: string | null` Body param: IANA timezone the cron expression is evaluated in. ### Returns - `ScheduleUpdateResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const schedule = await client.agents.schedules.update('schedule_id', { agent_id: 'agent_id' }); console.log(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 `client.agents.schedules.delete(stringscheduleID, ScheduleDeleteParamsparams, RequestOptionsoptions?): DeleteResponse` **delete** `/agents/{agent_id}/schedules/{schedule_id}` Delete a run schedule permanently. ### Parameters - `scheduleID: string` - `params: ScheduleDeleteParams` - `agent_id: string` ### Returns - `DeleteResponse` - `id: string` - `message: string` ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const deleteResponse = await client.agents.schedules.delete('schedule_id', { agent_id: 'agent_id', }); console.log(deleteResponse.id); ``` #### Response ```json { "id": "id", "message": "message" } ``` ## Pause Run Schedule `client.agents.schedules.pause(stringscheduleID, SchedulePauseParamsparams, RequestOptionsoptions?): SchedulePauseResponse` **post** `/agents/{agent_id}/schedules/{schedule_id}/pause` Pause a run schedule so it stops firing. ### Parameters - `scheduleID: string` - `params: SchedulePauseParams` - `agent_id: string` Path param - `note?: string | null` Body param: Optional note explaining the pause. ### Returns - `SchedulePauseResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const response = await client.agents.schedules.pause('schedule_id', { agent_id: 'agent_id' }); console.log(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 `client.agents.schedules.resume(stringscheduleID, ScheduleResumeParamsparams, RequestOptionsoptions?): ScheduleResumeResponse` **post** `/agents/{agent_id}/schedules/{schedule_id}/resume` Resume a paused run schedule so it fires again. ### Parameters - `scheduleID: string` - `params: ScheduleResumeParams` - `agent_id: string` Path param - `note?: string | null` Body param: Optional note explaining the resume. ### Returns - `ScheduleResumeResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const response = await client.agents.schedules.resume('schedule_id', { agent_id: 'agent_id' }); console.log(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 `client.agents.schedules.trigger(stringscheduleID, ScheduleTriggerParamsparams, RequestOptionsoptions?): 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 - `scheduleID: string` - `params: ScheduleTriggerParams` - `agent_id: string` ### Returns - `ScheduleTriggerResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const response = await client.agents.schedules.trigger('schedule_id', { agent_id: 'agent_id' }); console.log(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 `client.agents.schedules.skip(stringscheduleID, ScheduleSkipParamsparams, RequestOptionsoptions?): ScheduleSkipResponse` **post** `/agents/{agent_id}/schedules/{schedule_id}/skip` Skip a recurring fire of the schedule. ### Parameters - `scheduleID: string` - `params: ScheduleSkipParams` - `agent_id: string` Path param - `scheduled_time: string` Body param: Specific scheduled fire time to skip. ### Returns - `ScheduleSkipResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const response = await client.agents.schedules.skip('schedule_id', { agent_id: 'agent_id', scheduled_time: '2019-12-27T18:11:19.117Z', }); console.log(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 `client.agents.schedules.unskip(stringscheduleID, ScheduleUnskipParamsparams, RequestOptionsoptions?): ScheduleUnskipResponse` **post** `/agents/{agent_id}/schedules/{schedule_id}/unskip` Remove a skip for a recurring fire of the schedule. ### Parameters - `scheduleID: string` - `params: ScheduleUnskipParams` - `agent_id: string` Path param - `scheduled_time: string` Body param: Specific scheduled fire time to unskip. ### Returns - `ScheduleUnskipResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const response = await client.agents.schedules.unskip('schedule_id', { agent_id: 'agent_id', scheduled_time: '2019-12-27T18:11:19.117Z', }); console.log(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 `client.agents.schedules.retrieveByName(stringname, ScheduleRetrieveByNameParamsparams, RequestOptionsoptions?): ScheduleRetrieveByNameResponse` **get** `/agents/{agent_id}/schedules/name/{name}` Get a run schedule by its active name. ### Parameters - `name: string` - `params: ScheduleRetrieveByNameParams` - `agent_id: string` ### Returns - `ScheduleRetrieveByNameResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const response = await client.agents.schedules.retrieveByName('name', { agent_id: 'agent_id' }); console.log(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 `client.agents.schedules.updateByName(stringname, ScheduleUpdateByNameParamsparams, RequestOptionsoptions?): ScheduleUpdateByNameResponse` **patch** `/agents/{agent_id}/schedules/name/{name}` Partially update a run schedule's definition by its active name. ### Parameters - `name: string` - `params: ScheduleUpdateByNameParams` - `agent_id: string` Path param - `cron_expression?: string | null` Body param: New cron cadence. Mutually exclusive with interval_seconds. - `description?: string | null` Body param: Optional description of what this schedule does. - `end_at?: string | null` Body param: When the schedule should stop being active. - `initial_input?: InitialInput | null` Body param: The first input delivered to each freshly created scheduled task. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `interval_seconds?: number | null` Body param: New interval cadence in seconds. Mutually exclusive with cron_expression. - `name?: string | null` Body param: Human-readable name, unique among active schedules for the agent. - `paused?: boolean | null` Body param: Pause/resume the schedule as part of the update. - `start_at?: string | null` Body param: When the schedule should start being active. - `task_metadata?: Record | null` Body param: Metadata copied onto each created task at fire time. - `task_params?: Record | null` Body param: Resolved config forwarded as task `params` at fire time. - `timezone?: string | null` Body param: IANA timezone the cron expression is evaluated in. ### Returns - `ScheduleUpdateByNameResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const response = await client.agents.schedules.updateByName('name', { agent_id: 'agent_id' }); console.log(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 `client.agents.schedules.deleteByName(stringname, ScheduleDeleteByNameParamsparams, RequestOptionsoptions?): DeleteResponse` **delete** `/agents/{agent_id}/schedules/name/{name}` Delete a run schedule by its active name. ### Parameters - `name: string` - `params: ScheduleDeleteByNameParams` - `agent_id: string` ### Returns - `DeleteResponse` - `id: string` - `message: string` ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const deleteResponse = await client.agents.schedules.deleteByName('name', { agent_id: 'agent_id' }); console.log(deleteResponse.id); ``` #### Response ```json { "id": "id", "message": "message" } ``` ## Pause Run Schedule By Name `client.agents.schedules.pauseByName(stringname, SchedulePauseByNameParamsparams, RequestOptionsoptions?): SchedulePauseByNameResponse` **post** `/agents/{agent_id}/schedules/name/{name}/pause` Pause a run schedule by its active name. ### Parameters - `name: string` - `params: SchedulePauseByNameParams` - `agent_id: string` Path param - `note?: string | null` Body param: Optional note explaining the pause. ### Returns - `SchedulePauseByNameResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const response = await client.agents.schedules.pauseByName('name', { agent_id: 'agent_id' }); console.log(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 `client.agents.schedules.resumeByName(stringname, ScheduleResumeByNameParamsparams, RequestOptionsoptions?): ScheduleResumeByNameResponse` **post** `/agents/{agent_id}/schedules/name/{name}/resume` Resume a paused run schedule by its active name. ### Parameters - `name: string` - `params: ScheduleResumeByNameParams` - `agent_id: string` Path param - `note?: string | null` Body param: Optional note explaining the resume. ### Returns - `ScheduleResumeByNameResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const response = await client.agents.schedules.resumeByName('name', { agent_id: 'agent_id' }); console.log(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 `client.agents.schedules.triggerByName(stringname, ScheduleTriggerByNameParamsparams, RequestOptionsoptions?): ScheduleTriggerByNameResponse` **post** `/agents/{agent_id}/schedules/name/{name}/trigger` Trigger an immediate, out-of-band run of the schedule by its active name. ### Parameters - `name: string` - `params: ScheduleTriggerByNameParams` - `agent_id: string` ### Returns - `ScheduleTriggerByNameResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Example ```typescript import Agentex from 'agentex'; const client = new Agentex({ apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted }); const response = await client.agents.schedules.triggerByName('name', { agent_id: 'agent_id' }); console.log(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 - `ScheduleCreateResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Schedule List Response - `ScheduleListResponse` Response model for listing run schedules. - `run_schedules: Array` The list of run schedules. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. - `total: number` The number of run schedules returned. ### Schedule Retrieve Response - `ScheduleRetrieveResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Schedule Update Response - `ScheduleUpdateResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Schedule Pause Response - `SchedulePauseResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Schedule Resume Response - `ScheduleResumeResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Schedule Trigger Response - `ScheduleTriggerResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Schedule Skip Response - `ScheduleSkipResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Schedule Unskip Response - `ScheduleUnskipResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Schedule Retrieve By Name Response - `ScheduleRetrieveByNameResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Schedule Update By Name Response - `ScheduleUpdateByNameResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Schedule Pause By Name Response - `SchedulePauseByNameResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Schedule Resume By Name Response - `ScheduleResumeByNameResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated. ### Schedule Trigger By Name Response - `ScheduleTriggerByNameResponse` Response model describing a scheduled agent run. - `id: string` The unique identifier of the run schedule. - `agent_id: string` The agent this schedule belongs to. - `initial_input: InitialInput` The initial input. - `content: string` The initial prompt delivered to the task. - `author?: MessageAuthor` The author attributed to the initial input. - `"user"` - `"agent"` - `type?: "text"` Input content type. - `"text"` - `initial_input_method: string` Delivery method, inferred from the agent's ACP type. - `name: string` Human-readable schedule name. - `created_at?: string | null` When the schedule was created. - `creator_principal?: CreatorPrincipal | null` Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time. - `account_id?: string | null` Account/workspace id of the creator. - `principal_type?: string | null` e.g. 'user' or 'service_account'. - `service_account_id?: string | null` Creator service-account id, if a service principal. - `user_id?: string | null` Creator user id, if a user principal. - `cron_expression?: string | null` Cron cadence, if cron-based. - `description?: string | null` Optional description. - `end_at?: string | null` Schedule deactivation time. - `interval_seconds?: number | null` Interval cadence in seconds, if interval-based. - `last_action_time?: string | null` When the schedule last fired. - `live_data_available?: boolean | null` Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested. - `next_action_times?: Array` Upcoming scheduled fire times. - `num_actions_taken?: number` Number of times the schedule has fired. - `paused?: boolean` Whether the schedule is paused. - `skipped_action_times?: Array` Skipped one-off scheduled fire times. - `start_at?: string | null` Schedule activation time. - `state?: "ACTIVE" | "PAUSED"` Live schedule state from Temporal. - `"ACTIVE"` - `"PAUSED"` - `task_metadata?: Record | null` Task metadata at fire time. - `task_params?: Record | null` Task params at fire time. - `timezone?: string` Timezone the cron expression is evaluated in. - `updated_at?: string | null` When the schedule was updated.