# Schedules

## Create Run Schedule

**post** `/agents/{agent_id}/schedules`

Create a recurring schedule that starts a fresh agent run on each fire.

### Path Parameters

- `agent_id: string`

### Body Parameters

- `initial_input: object { content, author, type }`

  The first input delivered to each created task.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "text"`

    Input content type.

    - `"text"`

- `name: string`

  Human-readable name, unique among active schedules for the agent.

- `cron_expression: optional string`

  Cron expression for the cadence (e.g. '0 17 * * MON-FRI'). Mutually exclusive with interval_seconds.

- `description: optional string`

  Optional description of what this schedule does.

- `end_at: optional string`

  When the schedule should stop being active.

- `interval_seconds: optional number`

  Interval cadence in seconds. Mutually exclusive with cron_expression.

- `paused: optional boolean`

  Whether to create the schedule in a paused state.

- `start_at: optional string`

  When the schedule should start being active.

- `task_metadata: optional map[unknown]`

  Metadata copied onto each created task at fire time.

- `task_params: optional map[unknown]`

  Resolved config forwarded as task `params` at fire time.

- `timezone: optional string`

  IANA timezone the cron expression is evaluated in (e.g. 'America/New_York').

### Returns

- `id: string`

  The unique identifier of the run schedule.

- `agent_id: string`

  The agent this schedule belongs to.

- `initial_input: object { content, author, type }`

  The initial input.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "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: optional string`

  When the schedule was created.

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

  Credential-free creator identity stored with the schedule.

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

  - `account_id: optional string`

    Account/workspace id of the creator.

  - `principal_type: optional string`

    e.g. 'user' or 'service_account'.

  - `service_account_id: optional string`

    Creator service-account id, if a service principal.

  - `user_id: optional string`

    Creator user id, if a user principal.

- `cron_expression: optional string`

  Cron cadence, if cron-based.

- `description: optional string`

  Optional description.

- `end_at: optional string`

  Schedule deactivation time.

- `interval_seconds: optional number`

  Interval cadence in seconds, if interval-based.

- `last_action_time: optional string`

  When the schedule last fired.

- `live_data_available: optional boolean`

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

- `next_action_times: optional array of string`

  Upcoming scheduled fire times.

- `num_actions_taken: optional number`

  Number of times the schedule has fired.

- `paused: optional boolean`

  Whether the schedule is paused.

- `skipped_action_times: optional array of string`

  Skipped one-off scheduled fire times.

- `start_at: optional string`

  Schedule activation time.

- `state: optional "ACTIVE" or "PAUSED"`

  Live schedule state from Temporal.

  - `"ACTIVE"`

  - `"PAUSED"`

- `task_metadata: optional map[unknown]`

  Task metadata at fire time.

- `task_params: optional map[unknown]`

  Task params at fire time.

- `timezone: optional string`

  Timezone the cron expression is evaluated in.

- `updated_at: optional string`

  When the schedule was updated.

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY" \
    -d '{
          "initial_input": {
            "content": "content"
          },
          "name": "name"
        }'
```

#### 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

**get** `/agents/{agent_id}/schedules`

List run schedules for an agent.

### Path Parameters

- `agent_id: string`

### Query Parameters

- `include_live: optional boolean`

  Include live Temporal state and upcoming action times.

- `limit: optional number`

### Returns

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

  The list of run schedules.

  - `id: string`

    The unique identifier of the run schedule.

  - `agent_id: string`

    The agent this schedule belongs to.

  - `initial_input: object { content, author, type }`

    The initial input.

    - `content: string`

      The initial prompt delivered to the task.

    - `author: optional MessageAuthor`

      The author attributed to the initial input.

      - `"user"`

      - `"agent"`

    - `type: optional "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: optional string`

    When the schedule was created.

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

    Credential-free creator identity stored with the schedule.

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

    - `account_id: optional string`

      Account/workspace id of the creator.

    - `principal_type: optional string`

      e.g. 'user' or 'service_account'.

    - `service_account_id: optional string`

      Creator service-account id, if a service principal.

    - `user_id: optional string`

      Creator user id, if a user principal.

  - `cron_expression: optional string`

    Cron cadence, if cron-based.

  - `description: optional string`

    Optional description.

  - `end_at: optional string`

    Schedule deactivation time.

  - `interval_seconds: optional number`

    Interval cadence in seconds, if interval-based.

  - `last_action_time: optional string`

    When the schedule last fired.

  - `live_data_available: optional boolean`

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

  - `next_action_times: optional array of string`

    Upcoming scheduled fire times.

  - `num_actions_taken: optional number`

    Number of times the schedule has fired.

  - `paused: optional boolean`

    Whether the schedule is paused.

  - `skipped_action_times: optional array of string`

    Skipped one-off scheduled fire times.

  - `start_at: optional string`

    Schedule activation time.

  - `state: optional "ACTIVE" or "PAUSED"`

    Live schedule state from Temporal.

    - `"ACTIVE"`

    - `"PAUSED"`

  - `task_metadata: optional map[unknown]`

    Task metadata at fire time.

  - `task_params: optional map[unknown]`

    Task params at fire time.

  - `timezone: optional string`

    Timezone the cron expression is evaluated in.

  - `updated_at: optional string`

    When the schedule was updated.

- `total: number`

  The number of run schedules returned.

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### 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

**get** `/agents/{agent_id}/schedules/{schedule_id}`

Get a run schedule by its id.

### Path Parameters

- `agent_id: string`

- `schedule_id: string`

### Returns

- `id: string`

  The unique identifier of the run schedule.

- `agent_id: string`

  The agent this schedule belongs to.

- `initial_input: object { content, author, type }`

  The initial input.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "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: optional string`

  When the schedule was created.

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

  Credential-free creator identity stored with the schedule.

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

  - `account_id: optional string`

    Account/workspace id of the creator.

  - `principal_type: optional string`

    e.g. 'user' or 'service_account'.

  - `service_account_id: optional string`

    Creator service-account id, if a service principal.

  - `user_id: optional string`

    Creator user id, if a user principal.

- `cron_expression: optional string`

  Cron cadence, if cron-based.

- `description: optional string`

  Optional description.

- `end_at: optional string`

  Schedule deactivation time.

- `interval_seconds: optional number`

  Interval cadence in seconds, if interval-based.

- `last_action_time: optional string`

  When the schedule last fired.

- `live_data_available: optional boolean`

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

- `next_action_times: optional array of string`

  Upcoming scheduled fire times.

- `num_actions_taken: optional number`

  Number of times the schedule has fired.

- `paused: optional boolean`

  Whether the schedule is paused.

- `skipped_action_times: optional array of string`

  Skipped one-off scheduled fire times.

- `start_at: optional string`

  Schedule activation time.

- `state: optional "ACTIVE" or "PAUSED"`

  Live schedule state from Temporal.

  - `"ACTIVE"`

  - `"PAUSED"`

- `task_metadata: optional map[unknown]`

  Task metadata at fire time.

- `task_params: optional map[unknown]`

  Task params at fire time.

- `timezone: optional string`

  Timezone the cron expression is evaluated in.

- `updated_at: optional string`

  When the schedule was updated.

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules/$SCHEDULE_ID \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### 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

**patch** `/agents/{agent_id}/schedules/{schedule_id}`

Partially update a run schedule's definition (cadence, window, input, etc.).

### Path Parameters

- `agent_id: string`

- `schedule_id: string`

### Body Parameters

- `cron_expression: optional string`

  New cron cadence. Mutually exclusive with interval_seconds.

- `description: optional string`

  Optional description of what this schedule does.

- `end_at: optional string`

  When the schedule should stop being active.

- `initial_input: optional object { content, author, type }`

  The first input delivered to each freshly created scheduled task.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "text"`

    Input content type.

    - `"text"`

- `interval_seconds: optional number`

  New interval cadence in seconds. Mutually exclusive with cron_expression.

- `name: optional string`

  Human-readable name, unique among active schedules for the agent.

- `paused: optional boolean`

  Pause/resume the schedule as part of the update.

- `start_at: optional string`

  When the schedule should start being active.

- `task_metadata: optional map[unknown]`

  Metadata copied onto each created task at fire time.

- `task_params: optional map[unknown]`

  Resolved config forwarded as task `params` at fire time.

- `timezone: optional string`

  IANA timezone the cron expression is evaluated in.

### Returns

- `id: string`

  The unique identifier of the run schedule.

- `agent_id: string`

  The agent this schedule belongs to.

- `initial_input: object { content, author, type }`

  The initial input.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "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: optional string`

  When the schedule was created.

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

  Credential-free creator identity stored with the schedule.

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

  - `account_id: optional string`

    Account/workspace id of the creator.

  - `principal_type: optional string`

    e.g. 'user' or 'service_account'.

  - `service_account_id: optional string`

    Creator service-account id, if a service principal.

  - `user_id: optional string`

    Creator user id, if a user principal.

- `cron_expression: optional string`

  Cron cadence, if cron-based.

- `description: optional string`

  Optional description.

- `end_at: optional string`

  Schedule deactivation time.

- `interval_seconds: optional number`

  Interval cadence in seconds, if interval-based.

- `last_action_time: optional string`

  When the schedule last fired.

- `live_data_available: optional boolean`

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

- `next_action_times: optional array of string`

  Upcoming scheduled fire times.

- `num_actions_taken: optional number`

  Number of times the schedule has fired.

- `paused: optional boolean`

  Whether the schedule is paused.

- `skipped_action_times: optional array of string`

  Skipped one-off scheduled fire times.

- `start_at: optional string`

  Schedule activation time.

- `state: optional "ACTIVE" or "PAUSED"`

  Live schedule state from Temporal.

  - `"ACTIVE"`

  - `"PAUSED"`

- `task_metadata: optional map[unknown]`

  Task metadata at fire time.

- `task_params: optional map[unknown]`

  Task params at fire time.

- `timezone: optional string`

  Timezone the cron expression is evaluated in.

- `updated_at: optional string`

  When the schedule was updated.

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules/$SCHEDULE_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY" \
    -d '{}'
```

#### 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

**delete** `/agents/{agent_id}/schedules/{schedule_id}`

Delete a run schedule permanently.

### Path Parameters

- `agent_id: string`

- `schedule_id: string`

### Returns

- `DeleteResponse object { id, message }`

  - `id: string`

  - `message: string`

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules/$SCHEDULE_ID \
    -X DELETE \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{
  "id": "id",
  "message": "message"
}
```

## Pause Run Schedule

**post** `/agents/{agent_id}/schedules/{schedule_id}/pause`

Pause a run schedule so it stops firing.

### Path Parameters

- `agent_id: string`

- `schedule_id: string`

### Body Parameters

- `note: optional string`

  Optional note explaining the pause.

### Returns

- `id: string`

  The unique identifier of the run schedule.

- `agent_id: string`

  The agent this schedule belongs to.

- `initial_input: object { content, author, type }`

  The initial input.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "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: optional string`

  When the schedule was created.

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

  Credential-free creator identity stored with the schedule.

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

  - `account_id: optional string`

    Account/workspace id of the creator.

  - `principal_type: optional string`

    e.g. 'user' or 'service_account'.

  - `service_account_id: optional string`

    Creator service-account id, if a service principal.

  - `user_id: optional string`

    Creator user id, if a user principal.

- `cron_expression: optional string`

  Cron cadence, if cron-based.

- `description: optional string`

  Optional description.

- `end_at: optional string`

  Schedule deactivation time.

- `interval_seconds: optional number`

  Interval cadence in seconds, if interval-based.

- `last_action_time: optional string`

  When the schedule last fired.

- `live_data_available: optional boolean`

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

- `next_action_times: optional array of string`

  Upcoming scheduled fire times.

- `num_actions_taken: optional number`

  Number of times the schedule has fired.

- `paused: optional boolean`

  Whether the schedule is paused.

- `skipped_action_times: optional array of string`

  Skipped one-off scheduled fire times.

- `start_at: optional string`

  Schedule activation time.

- `state: optional "ACTIVE" or "PAUSED"`

  Live schedule state from Temporal.

  - `"ACTIVE"`

  - `"PAUSED"`

- `task_metadata: optional map[unknown]`

  Task metadata at fire time.

- `task_params: optional map[unknown]`

  Task params at fire time.

- `timezone: optional string`

  Timezone the cron expression is evaluated in.

- `updated_at: optional string`

  When the schedule was updated.

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules/$SCHEDULE_ID/pause \
    -X POST \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### 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

**post** `/agents/{agent_id}/schedules/{schedule_id}/resume`

Resume a paused run schedule so it fires again.

### Path Parameters

- `agent_id: string`

- `schedule_id: string`

### Body Parameters

- `note: optional string`

  Optional note explaining the resume.

### Returns

- `id: string`

  The unique identifier of the run schedule.

- `agent_id: string`

  The agent this schedule belongs to.

- `initial_input: object { content, author, type }`

  The initial input.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "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: optional string`

  When the schedule was created.

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

  Credential-free creator identity stored with the schedule.

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

  - `account_id: optional string`

    Account/workspace id of the creator.

  - `principal_type: optional string`

    e.g. 'user' or 'service_account'.

  - `service_account_id: optional string`

    Creator service-account id, if a service principal.

  - `user_id: optional string`

    Creator user id, if a user principal.

- `cron_expression: optional string`

  Cron cadence, if cron-based.

- `description: optional string`

  Optional description.

- `end_at: optional string`

  Schedule deactivation time.

- `interval_seconds: optional number`

  Interval cadence in seconds, if interval-based.

- `last_action_time: optional string`

  When the schedule last fired.

- `live_data_available: optional boolean`

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

- `next_action_times: optional array of string`

  Upcoming scheduled fire times.

- `num_actions_taken: optional number`

  Number of times the schedule has fired.

- `paused: optional boolean`

  Whether the schedule is paused.

- `skipped_action_times: optional array of string`

  Skipped one-off scheduled fire times.

- `start_at: optional string`

  Schedule activation time.

- `state: optional "ACTIVE" or "PAUSED"`

  Live schedule state from Temporal.

  - `"ACTIVE"`

  - `"PAUSED"`

- `task_metadata: optional map[unknown]`

  Task metadata at fire time.

- `task_params: optional map[unknown]`

  Task params at fire time.

- `timezone: optional string`

  Timezone the cron expression is evaluated in.

- `updated_at: optional string`

  When the schedule was updated.

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules/$SCHEDULE_ID/resume \
    -X POST \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### 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

**post** `/agents/{agent_id}/schedules/{schedule_id}/trigger`

Trigger an immediate, out-of-band run of the schedule (in addition to its cadence).

### Path Parameters

- `agent_id: string`

- `schedule_id: string`

### Returns

- `id: string`

  The unique identifier of the run schedule.

- `agent_id: string`

  The agent this schedule belongs to.

- `initial_input: object { content, author, type }`

  The initial input.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "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: optional string`

  When the schedule was created.

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

  Credential-free creator identity stored with the schedule.

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

  - `account_id: optional string`

    Account/workspace id of the creator.

  - `principal_type: optional string`

    e.g. 'user' or 'service_account'.

  - `service_account_id: optional string`

    Creator service-account id, if a service principal.

  - `user_id: optional string`

    Creator user id, if a user principal.

- `cron_expression: optional string`

  Cron cadence, if cron-based.

- `description: optional string`

  Optional description.

- `end_at: optional string`

  Schedule deactivation time.

- `interval_seconds: optional number`

  Interval cadence in seconds, if interval-based.

- `last_action_time: optional string`

  When the schedule last fired.

- `live_data_available: optional boolean`

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

- `next_action_times: optional array of string`

  Upcoming scheduled fire times.

- `num_actions_taken: optional number`

  Number of times the schedule has fired.

- `paused: optional boolean`

  Whether the schedule is paused.

- `skipped_action_times: optional array of string`

  Skipped one-off scheduled fire times.

- `start_at: optional string`

  Schedule activation time.

- `state: optional "ACTIVE" or "PAUSED"`

  Live schedule state from Temporal.

  - `"ACTIVE"`

  - `"PAUSED"`

- `task_metadata: optional map[unknown]`

  Task metadata at fire time.

- `task_params: optional map[unknown]`

  Task params at fire time.

- `timezone: optional string`

  Timezone the cron expression is evaluated in.

- `updated_at: optional string`

  When the schedule was updated.

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules/$SCHEDULE_ID/trigger \
    -X POST \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### 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

**post** `/agents/{agent_id}/schedules/{schedule_id}/skip`

Skip a recurring fire of the schedule.

### Path Parameters

- `agent_id: string`

- `schedule_id: string`

### Body Parameters

- `scheduled_time: string`

  Specific scheduled fire time to skip.

### Returns

- `id: string`

  The unique identifier of the run schedule.

- `agent_id: string`

  The agent this schedule belongs to.

- `initial_input: object { content, author, type }`

  The initial input.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "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: optional string`

  When the schedule was created.

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

  Credential-free creator identity stored with the schedule.

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

  - `account_id: optional string`

    Account/workspace id of the creator.

  - `principal_type: optional string`

    e.g. 'user' or 'service_account'.

  - `service_account_id: optional string`

    Creator service-account id, if a service principal.

  - `user_id: optional string`

    Creator user id, if a user principal.

- `cron_expression: optional string`

  Cron cadence, if cron-based.

- `description: optional string`

  Optional description.

- `end_at: optional string`

  Schedule deactivation time.

- `interval_seconds: optional number`

  Interval cadence in seconds, if interval-based.

- `last_action_time: optional string`

  When the schedule last fired.

- `live_data_available: optional boolean`

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

- `next_action_times: optional array of string`

  Upcoming scheduled fire times.

- `num_actions_taken: optional number`

  Number of times the schedule has fired.

- `paused: optional boolean`

  Whether the schedule is paused.

- `skipped_action_times: optional array of string`

  Skipped one-off scheduled fire times.

- `start_at: optional string`

  Schedule activation time.

- `state: optional "ACTIVE" or "PAUSED"`

  Live schedule state from Temporal.

  - `"ACTIVE"`

  - `"PAUSED"`

- `task_metadata: optional map[unknown]`

  Task metadata at fire time.

- `task_params: optional map[unknown]`

  Task params at fire time.

- `timezone: optional string`

  Timezone the cron expression is evaluated in.

- `updated_at: optional string`

  When the schedule was updated.

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules/$SCHEDULE_ID/skip \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY" \
    -d '{
          "scheduled_time": "2019-12-27T18:11:19.117Z"
        }'
```

#### 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

**post** `/agents/{agent_id}/schedules/{schedule_id}/unskip`

Remove a skip for a recurring fire of the schedule.

### Path Parameters

- `agent_id: string`

- `schedule_id: string`

### Body Parameters

- `scheduled_time: string`

  Specific scheduled fire time to unskip.

### Returns

- `id: string`

  The unique identifier of the run schedule.

- `agent_id: string`

  The agent this schedule belongs to.

- `initial_input: object { content, author, type }`

  The initial input.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "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: optional string`

  When the schedule was created.

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

  Credential-free creator identity stored with the schedule.

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

  - `account_id: optional string`

    Account/workspace id of the creator.

  - `principal_type: optional string`

    e.g. 'user' or 'service_account'.

  - `service_account_id: optional string`

    Creator service-account id, if a service principal.

  - `user_id: optional string`

    Creator user id, if a user principal.

- `cron_expression: optional string`

  Cron cadence, if cron-based.

- `description: optional string`

  Optional description.

- `end_at: optional string`

  Schedule deactivation time.

- `interval_seconds: optional number`

  Interval cadence in seconds, if interval-based.

- `last_action_time: optional string`

  When the schedule last fired.

- `live_data_available: optional boolean`

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

- `next_action_times: optional array of string`

  Upcoming scheduled fire times.

- `num_actions_taken: optional number`

  Number of times the schedule has fired.

- `paused: optional boolean`

  Whether the schedule is paused.

- `skipped_action_times: optional array of string`

  Skipped one-off scheduled fire times.

- `start_at: optional string`

  Schedule activation time.

- `state: optional "ACTIVE" or "PAUSED"`

  Live schedule state from Temporal.

  - `"ACTIVE"`

  - `"PAUSED"`

- `task_metadata: optional map[unknown]`

  Task metadata at fire time.

- `task_params: optional map[unknown]`

  Task params at fire time.

- `timezone: optional string`

  Timezone the cron expression is evaluated in.

- `updated_at: optional string`

  When the schedule was updated.

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules/$SCHEDULE_ID/unskip \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY" \
    -d '{
          "scheduled_time": "2019-12-27T18:11:19.117Z"
        }'
```

#### 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

**get** `/agents/{agent_id}/schedules/name/{name}`

Get a run schedule by its active name.

### Path Parameters

- `agent_id: string`

- `name: string`

### Returns

- `id: string`

  The unique identifier of the run schedule.

- `agent_id: string`

  The agent this schedule belongs to.

- `initial_input: object { content, author, type }`

  The initial input.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "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: optional string`

  When the schedule was created.

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

  Credential-free creator identity stored with the schedule.

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

  - `account_id: optional string`

    Account/workspace id of the creator.

  - `principal_type: optional string`

    e.g. 'user' or 'service_account'.

  - `service_account_id: optional string`

    Creator service-account id, if a service principal.

  - `user_id: optional string`

    Creator user id, if a user principal.

- `cron_expression: optional string`

  Cron cadence, if cron-based.

- `description: optional string`

  Optional description.

- `end_at: optional string`

  Schedule deactivation time.

- `interval_seconds: optional number`

  Interval cadence in seconds, if interval-based.

- `last_action_time: optional string`

  When the schedule last fired.

- `live_data_available: optional boolean`

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

- `next_action_times: optional array of string`

  Upcoming scheduled fire times.

- `num_actions_taken: optional number`

  Number of times the schedule has fired.

- `paused: optional boolean`

  Whether the schedule is paused.

- `skipped_action_times: optional array of string`

  Skipped one-off scheduled fire times.

- `start_at: optional string`

  Schedule activation time.

- `state: optional "ACTIVE" or "PAUSED"`

  Live schedule state from Temporal.

  - `"ACTIVE"`

  - `"PAUSED"`

- `task_metadata: optional map[unknown]`

  Task metadata at fire time.

- `task_params: optional map[unknown]`

  Task params at fire time.

- `timezone: optional string`

  Timezone the cron expression is evaluated in.

- `updated_at: optional string`

  When the schedule was updated.

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules/name/$NAME \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### 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

**patch** `/agents/{agent_id}/schedules/name/{name}`

Partially update a run schedule's definition by its active name.

### Path Parameters

- `agent_id: string`

- `name: string`

### Body Parameters

- `cron_expression: optional string`

  New cron cadence. Mutually exclusive with interval_seconds.

- `description: optional string`

  Optional description of what this schedule does.

- `end_at: optional string`

  When the schedule should stop being active.

- `initial_input: optional object { content, author, type }`

  The first input delivered to each freshly created scheduled task.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "text"`

    Input content type.

    - `"text"`

- `interval_seconds: optional number`

  New interval cadence in seconds. Mutually exclusive with cron_expression.

- `name: optional string`

  Human-readable name, unique among active schedules for the agent.

- `paused: optional boolean`

  Pause/resume the schedule as part of the update.

- `start_at: optional string`

  When the schedule should start being active.

- `task_metadata: optional map[unknown]`

  Metadata copied onto each created task at fire time.

- `task_params: optional map[unknown]`

  Resolved config forwarded as task `params` at fire time.

- `timezone: optional string`

  IANA timezone the cron expression is evaluated in.

### Returns

- `id: string`

  The unique identifier of the run schedule.

- `agent_id: string`

  The agent this schedule belongs to.

- `initial_input: object { content, author, type }`

  The initial input.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "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: optional string`

  When the schedule was created.

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

  Credential-free creator identity stored with the schedule.

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

  - `account_id: optional string`

    Account/workspace id of the creator.

  - `principal_type: optional string`

    e.g. 'user' or 'service_account'.

  - `service_account_id: optional string`

    Creator service-account id, if a service principal.

  - `user_id: optional string`

    Creator user id, if a user principal.

- `cron_expression: optional string`

  Cron cadence, if cron-based.

- `description: optional string`

  Optional description.

- `end_at: optional string`

  Schedule deactivation time.

- `interval_seconds: optional number`

  Interval cadence in seconds, if interval-based.

- `last_action_time: optional string`

  When the schedule last fired.

- `live_data_available: optional boolean`

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

- `next_action_times: optional array of string`

  Upcoming scheduled fire times.

- `num_actions_taken: optional number`

  Number of times the schedule has fired.

- `paused: optional boolean`

  Whether the schedule is paused.

- `skipped_action_times: optional array of string`

  Skipped one-off scheduled fire times.

- `start_at: optional string`

  Schedule activation time.

- `state: optional "ACTIVE" or "PAUSED"`

  Live schedule state from Temporal.

  - `"ACTIVE"`

  - `"PAUSED"`

- `task_metadata: optional map[unknown]`

  Task metadata at fire time.

- `task_params: optional map[unknown]`

  Task params at fire time.

- `timezone: optional string`

  Timezone the cron expression is evaluated in.

- `updated_at: optional string`

  When the schedule was updated.

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules/name/$NAME \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY" \
    -d '{}'
```

#### 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

**delete** `/agents/{agent_id}/schedules/name/{name}`

Delete a run schedule by its active name.

### Path Parameters

- `agent_id: string`

- `name: string`

### Returns

- `DeleteResponse object { id, message }`

  - `id: string`

  - `message: string`

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules/name/$NAME \
    -X DELETE \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{
  "id": "id",
  "message": "message"
}
```

## Pause Run Schedule By Name

**post** `/agents/{agent_id}/schedules/name/{name}/pause`

Pause a run schedule by its active name.

### Path Parameters

- `agent_id: string`

- `name: string`

### Body Parameters

- `note: optional string`

  Optional note explaining the pause.

### Returns

- `id: string`

  The unique identifier of the run schedule.

- `agent_id: string`

  The agent this schedule belongs to.

- `initial_input: object { content, author, type }`

  The initial input.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "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: optional string`

  When the schedule was created.

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

  Credential-free creator identity stored with the schedule.

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

  - `account_id: optional string`

    Account/workspace id of the creator.

  - `principal_type: optional string`

    e.g. 'user' or 'service_account'.

  - `service_account_id: optional string`

    Creator service-account id, if a service principal.

  - `user_id: optional string`

    Creator user id, if a user principal.

- `cron_expression: optional string`

  Cron cadence, if cron-based.

- `description: optional string`

  Optional description.

- `end_at: optional string`

  Schedule deactivation time.

- `interval_seconds: optional number`

  Interval cadence in seconds, if interval-based.

- `last_action_time: optional string`

  When the schedule last fired.

- `live_data_available: optional boolean`

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

- `next_action_times: optional array of string`

  Upcoming scheduled fire times.

- `num_actions_taken: optional number`

  Number of times the schedule has fired.

- `paused: optional boolean`

  Whether the schedule is paused.

- `skipped_action_times: optional array of string`

  Skipped one-off scheduled fire times.

- `start_at: optional string`

  Schedule activation time.

- `state: optional "ACTIVE" or "PAUSED"`

  Live schedule state from Temporal.

  - `"ACTIVE"`

  - `"PAUSED"`

- `task_metadata: optional map[unknown]`

  Task metadata at fire time.

- `task_params: optional map[unknown]`

  Task params at fire time.

- `timezone: optional string`

  Timezone the cron expression is evaluated in.

- `updated_at: optional string`

  When the schedule was updated.

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules/name/$NAME/pause \
    -X POST \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### 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

**post** `/agents/{agent_id}/schedules/name/{name}/resume`

Resume a paused run schedule by its active name.

### Path Parameters

- `agent_id: string`

- `name: string`

### Body Parameters

- `note: optional string`

  Optional note explaining the resume.

### Returns

- `id: string`

  The unique identifier of the run schedule.

- `agent_id: string`

  The agent this schedule belongs to.

- `initial_input: object { content, author, type }`

  The initial input.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "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: optional string`

  When the schedule was created.

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

  Credential-free creator identity stored with the schedule.

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

  - `account_id: optional string`

    Account/workspace id of the creator.

  - `principal_type: optional string`

    e.g. 'user' or 'service_account'.

  - `service_account_id: optional string`

    Creator service-account id, if a service principal.

  - `user_id: optional string`

    Creator user id, if a user principal.

- `cron_expression: optional string`

  Cron cadence, if cron-based.

- `description: optional string`

  Optional description.

- `end_at: optional string`

  Schedule deactivation time.

- `interval_seconds: optional number`

  Interval cadence in seconds, if interval-based.

- `last_action_time: optional string`

  When the schedule last fired.

- `live_data_available: optional boolean`

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

- `next_action_times: optional array of string`

  Upcoming scheduled fire times.

- `num_actions_taken: optional number`

  Number of times the schedule has fired.

- `paused: optional boolean`

  Whether the schedule is paused.

- `skipped_action_times: optional array of string`

  Skipped one-off scheduled fire times.

- `start_at: optional string`

  Schedule activation time.

- `state: optional "ACTIVE" or "PAUSED"`

  Live schedule state from Temporal.

  - `"ACTIVE"`

  - `"PAUSED"`

- `task_metadata: optional map[unknown]`

  Task metadata at fire time.

- `task_params: optional map[unknown]`

  Task params at fire time.

- `timezone: optional string`

  Timezone the cron expression is evaluated in.

- `updated_at: optional string`

  When the schedule was updated.

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules/name/$NAME/resume \
    -X POST \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### 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

**post** `/agents/{agent_id}/schedules/name/{name}/trigger`

Trigger an immediate, out-of-band run of the schedule by its active name.

### Path Parameters

- `agent_id: string`

- `name: string`

### Returns

- `id: string`

  The unique identifier of the run schedule.

- `agent_id: string`

  The agent this schedule belongs to.

- `initial_input: object { content, author, type }`

  The initial input.

  - `content: string`

    The initial prompt delivered to the task.

  - `author: optional MessageAuthor`

    The author attributed to the initial input.

    - `"user"`

    - `"agent"`

  - `type: optional "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: optional string`

  When the schedule was created.

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

  Credential-free creator identity stored with the schedule.

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

  - `account_id: optional string`

    Account/workspace id of the creator.

  - `principal_type: optional string`

    e.g. 'user' or 'service_account'.

  - `service_account_id: optional string`

    Creator service-account id, if a service principal.

  - `user_id: optional string`

    Creator user id, if a user principal.

- `cron_expression: optional string`

  Cron cadence, if cron-based.

- `description: optional string`

  Optional description.

- `end_at: optional string`

  Schedule deactivation time.

- `interval_seconds: optional number`

  Interval cadence in seconds, if interval-based.

- `last_action_time: optional string`

  When the schedule last fired.

- `live_data_available: optional boolean`

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

- `next_action_times: optional array of string`

  Upcoming scheduled fire times.

- `num_actions_taken: optional number`

  Number of times the schedule has fired.

- `paused: optional boolean`

  Whether the schedule is paused.

- `skipped_action_times: optional array of string`

  Skipped one-off scheduled fire times.

- `start_at: optional string`

  Schedule activation time.

- `state: optional "ACTIVE" or "PAUSED"`

  Live schedule state from Temporal.

  - `"ACTIVE"`

  - `"PAUSED"`

- `task_metadata: optional map[unknown]`

  Task metadata at fire time.

- `task_params: optional map[unknown]`

  Task params at fire time.

- `timezone: optional string`

  Timezone the cron expression is evaluated in.

- `updated_at: optional string`

  When the schedule was updated.

### Example

```http
curl http://localhost:5003/agents/$AGENT_ID/schedules/name/$NAME/trigger \
    -X POST \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### 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 object { id, agent_id, initial_input, 20 more }`

  Response model describing a scheduled agent run.

  - `id: string`

    The unique identifier of the run schedule.

  - `agent_id: string`

    The agent this schedule belongs to.

  - `initial_input: object { content, author, type }`

    The initial input.

    - `content: string`

      The initial prompt delivered to the task.

    - `author: optional MessageAuthor`

      The author attributed to the initial input.

      - `"user"`

      - `"agent"`

    - `type: optional "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: optional string`

    When the schedule was created.

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

    Credential-free creator identity stored with the schedule.

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

    - `account_id: optional string`

      Account/workspace id of the creator.

    - `principal_type: optional string`

      e.g. 'user' or 'service_account'.

    - `service_account_id: optional string`

      Creator service-account id, if a service principal.

    - `user_id: optional string`

      Creator user id, if a user principal.

  - `cron_expression: optional string`

    Cron cadence, if cron-based.

  - `description: optional string`

    Optional description.

  - `end_at: optional string`

    Schedule deactivation time.

  - `interval_seconds: optional number`

    Interval cadence in seconds, if interval-based.

  - `last_action_time: optional string`

    When the schedule last fired.

  - `live_data_available: optional boolean`

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

  - `next_action_times: optional array of string`

    Upcoming scheduled fire times.

  - `num_actions_taken: optional number`

    Number of times the schedule has fired.

  - `paused: optional boolean`

    Whether the schedule is paused.

  - `skipped_action_times: optional array of string`

    Skipped one-off scheduled fire times.

  - `start_at: optional string`

    Schedule activation time.

  - `state: optional "ACTIVE" or "PAUSED"`

    Live schedule state from Temporal.

    - `"ACTIVE"`

    - `"PAUSED"`

  - `task_metadata: optional map[unknown]`

    Task metadata at fire time.

  - `task_params: optional map[unknown]`

    Task params at fire time.

  - `timezone: optional string`

    Timezone the cron expression is evaluated in.

  - `updated_at: optional string`

    When the schedule was updated.

### Schedule List Response

- `ScheduleListResponse object { run_schedules, total }`

  Response model for listing run schedules.

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

    The list of run schedules.

    - `id: string`

      The unique identifier of the run schedule.

    - `agent_id: string`

      The agent this schedule belongs to.

    - `initial_input: object { content, author, type }`

      The initial input.

      - `content: string`

        The initial prompt delivered to the task.

      - `author: optional MessageAuthor`

        The author attributed to the initial input.

        - `"user"`

        - `"agent"`

      - `type: optional "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: optional string`

      When the schedule was created.

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

      Credential-free creator identity stored with the schedule.

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

      - `account_id: optional string`

        Account/workspace id of the creator.

      - `principal_type: optional string`

        e.g. 'user' or 'service_account'.

      - `service_account_id: optional string`

        Creator service-account id, if a service principal.

      - `user_id: optional string`

        Creator user id, if a user principal.

    - `cron_expression: optional string`

      Cron cadence, if cron-based.

    - `description: optional string`

      Optional description.

    - `end_at: optional string`

      Schedule deactivation time.

    - `interval_seconds: optional number`

      Interval cadence in seconds, if interval-based.

    - `last_action_time: optional string`

      When the schedule last fired.

    - `live_data_available: optional boolean`

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

    - `next_action_times: optional array of string`

      Upcoming scheduled fire times.

    - `num_actions_taken: optional number`

      Number of times the schedule has fired.

    - `paused: optional boolean`

      Whether the schedule is paused.

    - `skipped_action_times: optional array of string`

      Skipped one-off scheduled fire times.

    - `start_at: optional string`

      Schedule activation time.

    - `state: optional "ACTIVE" or "PAUSED"`

      Live schedule state from Temporal.

      - `"ACTIVE"`

      - `"PAUSED"`

    - `task_metadata: optional map[unknown]`

      Task metadata at fire time.

    - `task_params: optional map[unknown]`

      Task params at fire time.

    - `timezone: optional string`

      Timezone the cron expression is evaluated in.

    - `updated_at: optional string`

      When the schedule was updated.

  - `total: number`

    The number of run schedules returned.

### Schedule Retrieve Response

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

  Response model describing a scheduled agent run.

  - `id: string`

    The unique identifier of the run schedule.

  - `agent_id: string`

    The agent this schedule belongs to.

  - `initial_input: object { content, author, type }`

    The initial input.

    - `content: string`

      The initial prompt delivered to the task.

    - `author: optional MessageAuthor`

      The author attributed to the initial input.

      - `"user"`

      - `"agent"`

    - `type: optional "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: optional string`

    When the schedule was created.

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

    Credential-free creator identity stored with the schedule.

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

    - `account_id: optional string`

      Account/workspace id of the creator.

    - `principal_type: optional string`

      e.g. 'user' or 'service_account'.

    - `service_account_id: optional string`

      Creator service-account id, if a service principal.

    - `user_id: optional string`

      Creator user id, if a user principal.

  - `cron_expression: optional string`

    Cron cadence, if cron-based.

  - `description: optional string`

    Optional description.

  - `end_at: optional string`

    Schedule deactivation time.

  - `interval_seconds: optional number`

    Interval cadence in seconds, if interval-based.

  - `last_action_time: optional string`

    When the schedule last fired.

  - `live_data_available: optional boolean`

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

  - `next_action_times: optional array of string`

    Upcoming scheduled fire times.

  - `num_actions_taken: optional number`

    Number of times the schedule has fired.

  - `paused: optional boolean`

    Whether the schedule is paused.

  - `skipped_action_times: optional array of string`

    Skipped one-off scheduled fire times.

  - `start_at: optional string`

    Schedule activation time.

  - `state: optional "ACTIVE" or "PAUSED"`

    Live schedule state from Temporal.

    - `"ACTIVE"`

    - `"PAUSED"`

  - `task_metadata: optional map[unknown]`

    Task metadata at fire time.

  - `task_params: optional map[unknown]`

    Task params at fire time.

  - `timezone: optional string`

    Timezone the cron expression is evaluated in.

  - `updated_at: optional string`

    When the schedule was updated.

### Schedule Update Response

- `ScheduleUpdateResponse object { id, agent_id, initial_input, 20 more }`

  Response model describing a scheduled agent run.

  - `id: string`

    The unique identifier of the run schedule.

  - `agent_id: string`

    The agent this schedule belongs to.

  - `initial_input: object { content, author, type }`

    The initial input.

    - `content: string`

      The initial prompt delivered to the task.

    - `author: optional MessageAuthor`

      The author attributed to the initial input.

      - `"user"`

      - `"agent"`

    - `type: optional "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: optional string`

    When the schedule was created.

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

    Credential-free creator identity stored with the schedule.

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

    - `account_id: optional string`

      Account/workspace id of the creator.

    - `principal_type: optional string`

      e.g. 'user' or 'service_account'.

    - `service_account_id: optional string`

      Creator service-account id, if a service principal.

    - `user_id: optional string`

      Creator user id, if a user principal.

  - `cron_expression: optional string`

    Cron cadence, if cron-based.

  - `description: optional string`

    Optional description.

  - `end_at: optional string`

    Schedule deactivation time.

  - `interval_seconds: optional number`

    Interval cadence in seconds, if interval-based.

  - `last_action_time: optional string`

    When the schedule last fired.

  - `live_data_available: optional boolean`

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

  - `next_action_times: optional array of string`

    Upcoming scheduled fire times.

  - `num_actions_taken: optional number`

    Number of times the schedule has fired.

  - `paused: optional boolean`

    Whether the schedule is paused.

  - `skipped_action_times: optional array of string`

    Skipped one-off scheduled fire times.

  - `start_at: optional string`

    Schedule activation time.

  - `state: optional "ACTIVE" or "PAUSED"`

    Live schedule state from Temporal.

    - `"ACTIVE"`

    - `"PAUSED"`

  - `task_metadata: optional map[unknown]`

    Task metadata at fire time.

  - `task_params: optional map[unknown]`

    Task params at fire time.

  - `timezone: optional string`

    Timezone the cron expression is evaluated in.

  - `updated_at: optional string`

    When the schedule was updated.

### Schedule Pause Response

- `SchedulePauseResponse object { id, agent_id, initial_input, 20 more }`

  Response model describing a scheduled agent run.

  - `id: string`

    The unique identifier of the run schedule.

  - `agent_id: string`

    The agent this schedule belongs to.

  - `initial_input: object { content, author, type }`

    The initial input.

    - `content: string`

      The initial prompt delivered to the task.

    - `author: optional MessageAuthor`

      The author attributed to the initial input.

      - `"user"`

      - `"agent"`

    - `type: optional "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: optional string`

    When the schedule was created.

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

    Credential-free creator identity stored with the schedule.

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

    - `account_id: optional string`

      Account/workspace id of the creator.

    - `principal_type: optional string`

      e.g. 'user' or 'service_account'.

    - `service_account_id: optional string`

      Creator service-account id, if a service principal.

    - `user_id: optional string`

      Creator user id, if a user principal.

  - `cron_expression: optional string`

    Cron cadence, if cron-based.

  - `description: optional string`

    Optional description.

  - `end_at: optional string`

    Schedule deactivation time.

  - `interval_seconds: optional number`

    Interval cadence in seconds, if interval-based.

  - `last_action_time: optional string`

    When the schedule last fired.

  - `live_data_available: optional boolean`

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

  - `next_action_times: optional array of string`

    Upcoming scheduled fire times.

  - `num_actions_taken: optional number`

    Number of times the schedule has fired.

  - `paused: optional boolean`

    Whether the schedule is paused.

  - `skipped_action_times: optional array of string`

    Skipped one-off scheduled fire times.

  - `start_at: optional string`

    Schedule activation time.

  - `state: optional "ACTIVE" or "PAUSED"`

    Live schedule state from Temporal.

    - `"ACTIVE"`

    - `"PAUSED"`

  - `task_metadata: optional map[unknown]`

    Task metadata at fire time.

  - `task_params: optional map[unknown]`

    Task params at fire time.

  - `timezone: optional string`

    Timezone the cron expression is evaluated in.

  - `updated_at: optional string`

    When the schedule was updated.

### Schedule Resume Response

- `ScheduleResumeResponse object { id, agent_id, initial_input, 20 more }`

  Response model describing a scheduled agent run.

  - `id: string`

    The unique identifier of the run schedule.

  - `agent_id: string`

    The agent this schedule belongs to.

  - `initial_input: object { content, author, type }`

    The initial input.

    - `content: string`

      The initial prompt delivered to the task.

    - `author: optional MessageAuthor`

      The author attributed to the initial input.

      - `"user"`

      - `"agent"`

    - `type: optional "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: optional string`

    When the schedule was created.

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

    Credential-free creator identity stored with the schedule.

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

    - `account_id: optional string`

      Account/workspace id of the creator.

    - `principal_type: optional string`

      e.g. 'user' or 'service_account'.

    - `service_account_id: optional string`

      Creator service-account id, if a service principal.

    - `user_id: optional string`

      Creator user id, if a user principal.

  - `cron_expression: optional string`

    Cron cadence, if cron-based.

  - `description: optional string`

    Optional description.

  - `end_at: optional string`

    Schedule deactivation time.

  - `interval_seconds: optional number`

    Interval cadence in seconds, if interval-based.

  - `last_action_time: optional string`

    When the schedule last fired.

  - `live_data_available: optional boolean`

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

  - `next_action_times: optional array of string`

    Upcoming scheduled fire times.

  - `num_actions_taken: optional number`

    Number of times the schedule has fired.

  - `paused: optional boolean`

    Whether the schedule is paused.

  - `skipped_action_times: optional array of string`

    Skipped one-off scheduled fire times.

  - `start_at: optional string`

    Schedule activation time.

  - `state: optional "ACTIVE" or "PAUSED"`

    Live schedule state from Temporal.

    - `"ACTIVE"`

    - `"PAUSED"`

  - `task_metadata: optional map[unknown]`

    Task metadata at fire time.

  - `task_params: optional map[unknown]`

    Task params at fire time.

  - `timezone: optional string`

    Timezone the cron expression is evaluated in.

  - `updated_at: optional string`

    When the schedule was updated.

### Schedule Trigger Response

- `ScheduleTriggerResponse object { id, agent_id, initial_input, 20 more }`

  Response model describing a scheduled agent run.

  - `id: string`

    The unique identifier of the run schedule.

  - `agent_id: string`

    The agent this schedule belongs to.

  - `initial_input: object { content, author, type }`

    The initial input.

    - `content: string`

      The initial prompt delivered to the task.

    - `author: optional MessageAuthor`

      The author attributed to the initial input.

      - `"user"`

      - `"agent"`

    - `type: optional "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: optional string`

    When the schedule was created.

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

    Credential-free creator identity stored with the schedule.

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

    - `account_id: optional string`

      Account/workspace id of the creator.

    - `principal_type: optional string`

      e.g. 'user' or 'service_account'.

    - `service_account_id: optional string`

      Creator service-account id, if a service principal.

    - `user_id: optional string`

      Creator user id, if a user principal.

  - `cron_expression: optional string`

    Cron cadence, if cron-based.

  - `description: optional string`

    Optional description.

  - `end_at: optional string`

    Schedule deactivation time.

  - `interval_seconds: optional number`

    Interval cadence in seconds, if interval-based.

  - `last_action_time: optional string`

    When the schedule last fired.

  - `live_data_available: optional boolean`

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

  - `next_action_times: optional array of string`

    Upcoming scheduled fire times.

  - `num_actions_taken: optional number`

    Number of times the schedule has fired.

  - `paused: optional boolean`

    Whether the schedule is paused.

  - `skipped_action_times: optional array of string`

    Skipped one-off scheduled fire times.

  - `start_at: optional string`

    Schedule activation time.

  - `state: optional "ACTIVE" or "PAUSED"`

    Live schedule state from Temporal.

    - `"ACTIVE"`

    - `"PAUSED"`

  - `task_metadata: optional map[unknown]`

    Task metadata at fire time.

  - `task_params: optional map[unknown]`

    Task params at fire time.

  - `timezone: optional string`

    Timezone the cron expression is evaluated in.

  - `updated_at: optional string`

    When the schedule was updated.

### Schedule Skip Response

- `ScheduleSkipResponse object { id, agent_id, initial_input, 20 more }`

  Response model describing a scheduled agent run.

  - `id: string`

    The unique identifier of the run schedule.

  - `agent_id: string`

    The agent this schedule belongs to.

  - `initial_input: object { content, author, type }`

    The initial input.

    - `content: string`

      The initial prompt delivered to the task.

    - `author: optional MessageAuthor`

      The author attributed to the initial input.

      - `"user"`

      - `"agent"`

    - `type: optional "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: optional string`

    When the schedule was created.

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

    Credential-free creator identity stored with the schedule.

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

    - `account_id: optional string`

      Account/workspace id of the creator.

    - `principal_type: optional string`

      e.g. 'user' or 'service_account'.

    - `service_account_id: optional string`

      Creator service-account id, if a service principal.

    - `user_id: optional string`

      Creator user id, if a user principal.

  - `cron_expression: optional string`

    Cron cadence, if cron-based.

  - `description: optional string`

    Optional description.

  - `end_at: optional string`

    Schedule deactivation time.

  - `interval_seconds: optional number`

    Interval cadence in seconds, if interval-based.

  - `last_action_time: optional string`

    When the schedule last fired.

  - `live_data_available: optional boolean`

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

  - `next_action_times: optional array of string`

    Upcoming scheduled fire times.

  - `num_actions_taken: optional number`

    Number of times the schedule has fired.

  - `paused: optional boolean`

    Whether the schedule is paused.

  - `skipped_action_times: optional array of string`

    Skipped one-off scheduled fire times.

  - `start_at: optional string`

    Schedule activation time.

  - `state: optional "ACTIVE" or "PAUSED"`

    Live schedule state from Temporal.

    - `"ACTIVE"`

    - `"PAUSED"`

  - `task_metadata: optional map[unknown]`

    Task metadata at fire time.

  - `task_params: optional map[unknown]`

    Task params at fire time.

  - `timezone: optional string`

    Timezone the cron expression is evaluated in.

  - `updated_at: optional string`

    When the schedule was updated.

### Schedule Unskip Response

- `ScheduleUnskipResponse object { id, agent_id, initial_input, 20 more }`

  Response model describing a scheduled agent run.

  - `id: string`

    The unique identifier of the run schedule.

  - `agent_id: string`

    The agent this schedule belongs to.

  - `initial_input: object { content, author, type }`

    The initial input.

    - `content: string`

      The initial prompt delivered to the task.

    - `author: optional MessageAuthor`

      The author attributed to the initial input.

      - `"user"`

      - `"agent"`

    - `type: optional "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: optional string`

    When the schedule was created.

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

    Credential-free creator identity stored with the schedule.

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

    - `account_id: optional string`

      Account/workspace id of the creator.

    - `principal_type: optional string`

      e.g. 'user' or 'service_account'.

    - `service_account_id: optional string`

      Creator service-account id, if a service principal.

    - `user_id: optional string`

      Creator user id, if a user principal.

  - `cron_expression: optional string`

    Cron cadence, if cron-based.

  - `description: optional string`

    Optional description.

  - `end_at: optional string`

    Schedule deactivation time.

  - `interval_seconds: optional number`

    Interval cadence in seconds, if interval-based.

  - `last_action_time: optional string`

    When the schedule last fired.

  - `live_data_available: optional boolean`

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

  - `next_action_times: optional array of string`

    Upcoming scheduled fire times.

  - `num_actions_taken: optional number`

    Number of times the schedule has fired.

  - `paused: optional boolean`

    Whether the schedule is paused.

  - `skipped_action_times: optional array of string`

    Skipped one-off scheduled fire times.

  - `start_at: optional string`

    Schedule activation time.

  - `state: optional "ACTIVE" or "PAUSED"`

    Live schedule state from Temporal.

    - `"ACTIVE"`

    - `"PAUSED"`

  - `task_metadata: optional map[unknown]`

    Task metadata at fire time.

  - `task_params: optional map[unknown]`

    Task params at fire time.

  - `timezone: optional string`

    Timezone the cron expression is evaluated in.

  - `updated_at: optional string`

    When the schedule was updated.

### Schedule Retrieve By Name Response

- `ScheduleRetrieveByNameResponse object { id, agent_id, initial_input, 20 more }`

  Response model describing a scheduled agent run.

  - `id: string`

    The unique identifier of the run schedule.

  - `agent_id: string`

    The agent this schedule belongs to.

  - `initial_input: object { content, author, type }`

    The initial input.

    - `content: string`

      The initial prompt delivered to the task.

    - `author: optional MessageAuthor`

      The author attributed to the initial input.

      - `"user"`

      - `"agent"`

    - `type: optional "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: optional string`

    When the schedule was created.

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

    Credential-free creator identity stored with the schedule.

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

    - `account_id: optional string`

      Account/workspace id of the creator.

    - `principal_type: optional string`

      e.g. 'user' or 'service_account'.

    - `service_account_id: optional string`

      Creator service-account id, if a service principal.

    - `user_id: optional string`

      Creator user id, if a user principal.

  - `cron_expression: optional string`

    Cron cadence, if cron-based.

  - `description: optional string`

    Optional description.

  - `end_at: optional string`

    Schedule deactivation time.

  - `interval_seconds: optional number`

    Interval cadence in seconds, if interval-based.

  - `last_action_time: optional string`

    When the schedule last fired.

  - `live_data_available: optional boolean`

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

  - `next_action_times: optional array of string`

    Upcoming scheduled fire times.

  - `num_actions_taken: optional number`

    Number of times the schedule has fired.

  - `paused: optional boolean`

    Whether the schedule is paused.

  - `skipped_action_times: optional array of string`

    Skipped one-off scheduled fire times.

  - `start_at: optional string`

    Schedule activation time.

  - `state: optional "ACTIVE" or "PAUSED"`

    Live schedule state from Temporal.

    - `"ACTIVE"`

    - `"PAUSED"`

  - `task_metadata: optional map[unknown]`

    Task metadata at fire time.

  - `task_params: optional map[unknown]`

    Task params at fire time.

  - `timezone: optional string`

    Timezone the cron expression is evaluated in.

  - `updated_at: optional string`

    When the schedule was updated.

### Schedule Update By Name Response

- `ScheduleUpdateByNameResponse object { id, agent_id, initial_input, 20 more }`

  Response model describing a scheduled agent run.

  - `id: string`

    The unique identifier of the run schedule.

  - `agent_id: string`

    The agent this schedule belongs to.

  - `initial_input: object { content, author, type }`

    The initial input.

    - `content: string`

      The initial prompt delivered to the task.

    - `author: optional MessageAuthor`

      The author attributed to the initial input.

      - `"user"`

      - `"agent"`

    - `type: optional "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: optional string`

    When the schedule was created.

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

    Credential-free creator identity stored with the schedule.

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

    - `account_id: optional string`

      Account/workspace id of the creator.

    - `principal_type: optional string`

      e.g. 'user' or 'service_account'.

    - `service_account_id: optional string`

      Creator service-account id, if a service principal.

    - `user_id: optional string`

      Creator user id, if a user principal.

  - `cron_expression: optional string`

    Cron cadence, if cron-based.

  - `description: optional string`

    Optional description.

  - `end_at: optional string`

    Schedule deactivation time.

  - `interval_seconds: optional number`

    Interval cadence in seconds, if interval-based.

  - `last_action_time: optional string`

    When the schedule last fired.

  - `live_data_available: optional boolean`

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

  - `next_action_times: optional array of string`

    Upcoming scheduled fire times.

  - `num_actions_taken: optional number`

    Number of times the schedule has fired.

  - `paused: optional boolean`

    Whether the schedule is paused.

  - `skipped_action_times: optional array of string`

    Skipped one-off scheduled fire times.

  - `start_at: optional string`

    Schedule activation time.

  - `state: optional "ACTIVE" or "PAUSED"`

    Live schedule state from Temporal.

    - `"ACTIVE"`

    - `"PAUSED"`

  - `task_metadata: optional map[unknown]`

    Task metadata at fire time.

  - `task_params: optional map[unknown]`

    Task params at fire time.

  - `timezone: optional string`

    Timezone the cron expression is evaluated in.

  - `updated_at: optional string`

    When the schedule was updated.

### Schedule Pause By Name Response

- `SchedulePauseByNameResponse object { id, agent_id, initial_input, 20 more }`

  Response model describing a scheduled agent run.

  - `id: string`

    The unique identifier of the run schedule.

  - `agent_id: string`

    The agent this schedule belongs to.

  - `initial_input: object { content, author, type }`

    The initial input.

    - `content: string`

      The initial prompt delivered to the task.

    - `author: optional MessageAuthor`

      The author attributed to the initial input.

      - `"user"`

      - `"agent"`

    - `type: optional "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: optional string`

    When the schedule was created.

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

    Credential-free creator identity stored with the schedule.

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

    - `account_id: optional string`

      Account/workspace id of the creator.

    - `principal_type: optional string`

      e.g. 'user' or 'service_account'.

    - `service_account_id: optional string`

      Creator service-account id, if a service principal.

    - `user_id: optional string`

      Creator user id, if a user principal.

  - `cron_expression: optional string`

    Cron cadence, if cron-based.

  - `description: optional string`

    Optional description.

  - `end_at: optional string`

    Schedule deactivation time.

  - `interval_seconds: optional number`

    Interval cadence in seconds, if interval-based.

  - `last_action_time: optional string`

    When the schedule last fired.

  - `live_data_available: optional boolean`

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

  - `next_action_times: optional array of string`

    Upcoming scheduled fire times.

  - `num_actions_taken: optional number`

    Number of times the schedule has fired.

  - `paused: optional boolean`

    Whether the schedule is paused.

  - `skipped_action_times: optional array of string`

    Skipped one-off scheduled fire times.

  - `start_at: optional string`

    Schedule activation time.

  - `state: optional "ACTIVE" or "PAUSED"`

    Live schedule state from Temporal.

    - `"ACTIVE"`

    - `"PAUSED"`

  - `task_metadata: optional map[unknown]`

    Task metadata at fire time.

  - `task_params: optional map[unknown]`

    Task params at fire time.

  - `timezone: optional string`

    Timezone the cron expression is evaluated in.

  - `updated_at: optional string`

    When the schedule was updated.

### Schedule Resume By Name Response

- `ScheduleResumeByNameResponse object { id, agent_id, initial_input, 20 more }`

  Response model describing a scheduled agent run.

  - `id: string`

    The unique identifier of the run schedule.

  - `agent_id: string`

    The agent this schedule belongs to.

  - `initial_input: object { content, author, type }`

    The initial input.

    - `content: string`

      The initial prompt delivered to the task.

    - `author: optional MessageAuthor`

      The author attributed to the initial input.

      - `"user"`

      - `"agent"`

    - `type: optional "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: optional string`

    When the schedule was created.

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

    Credential-free creator identity stored with the schedule.

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

    - `account_id: optional string`

      Account/workspace id of the creator.

    - `principal_type: optional string`

      e.g. 'user' or 'service_account'.

    - `service_account_id: optional string`

      Creator service-account id, if a service principal.

    - `user_id: optional string`

      Creator user id, if a user principal.

  - `cron_expression: optional string`

    Cron cadence, if cron-based.

  - `description: optional string`

    Optional description.

  - `end_at: optional string`

    Schedule deactivation time.

  - `interval_seconds: optional number`

    Interval cadence in seconds, if interval-based.

  - `last_action_time: optional string`

    When the schedule last fired.

  - `live_data_available: optional boolean`

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

  - `next_action_times: optional array of string`

    Upcoming scheduled fire times.

  - `num_actions_taken: optional number`

    Number of times the schedule has fired.

  - `paused: optional boolean`

    Whether the schedule is paused.

  - `skipped_action_times: optional array of string`

    Skipped one-off scheduled fire times.

  - `start_at: optional string`

    Schedule activation time.

  - `state: optional "ACTIVE" or "PAUSED"`

    Live schedule state from Temporal.

    - `"ACTIVE"`

    - `"PAUSED"`

  - `task_metadata: optional map[unknown]`

    Task metadata at fire time.

  - `task_params: optional map[unknown]`

    Task params at fire time.

  - `timezone: optional string`

    Timezone the cron expression is evaluated in.

  - `updated_at: optional string`

    When the schedule was updated.

### Schedule Trigger By Name Response

- `ScheduleTriggerByNameResponse object { id, agent_id, initial_input, 20 more }`

  Response model describing a scheduled agent run.

  - `id: string`

    The unique identifier of the run schedule.

  - `agent_id: string`

    The agent this schedule belongs to.

  - `initial_input: object { content, author, type }`

    The initial input.

    - `content: string`

      The initial prompt delivered to the task.

    - `author: optional MessageAuthor`

      The author attributed to the initial input.

      - `"user"`

      - `"agent"`

    - `type: optional "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: optional string`

    When the schedule was created.

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

    Credential-free creator identity stored with the schedule.

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

    - `account_id: optional string`

      Account/workspace id of the creator.

    - `principal_type: optional string`

      e.g. 'user' or 'service_account'.

    - `service_account_id: optional string`

      Creator service-account id, if a service principal.

    - `user_id: optional string`

      Creator user id, if a user principal.

  - `cron_expression: optional string`

    Cron cadence, if cron-based.

  - `description: optional string`

    Optional description.

  - `end_at: optional string`

    Schedule deactivation time.

  - `interval_seconds: optional number`

    Interval cadence in seconds, if interval-based.

  - `last_action_time: optional string`

    When the schedule last fired.

  - `live_data_available: optional boolean`

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

  - `next_action_times: optional array of string`

    Upcoming scheduled fire times.

  - `num_actions_taken: optional number`

    Number of times the schedule has fired.

  - `paused: optional boolean`

    Whether the schedule is paused.

  - `skipped_action_times: optional array of string`

    Skipped one-off scheduled fire times.

  - `start_at: optional string`

    Schedule activation time.

  - `state: optional "ACTIVE" or "PAUSED"`

    Live schedule state from Temporal.

    - `"ACTIVE"`

    - `"PAUSED"`

  - `task_metadata: optional map[unknown]`

    Task metadata at fire time.

  - `task_params: optional map[unknown]`

    Task params at fire time.

  - `timezone: optional string`

    Timezone the cron expression is evaluated in.

  - `updated_at: optional string`

    When the schedule was updated.