Skip to main content
GET
/
schedule
List all schedules
curl --request GET \
  --url https://api.example.com/schedule/ \
  --header 'x-user-id: <x-user-id>'
{
  "schedules": [
    {
      "user_id": "<string>",
      "agent_id": "<string>",
      "data": {
        "name": "<string>",
        "cron_expression": "<string>",
        "started_at": "2023-11-07T05:31:56Z",
        "chat_model_config": {
          "type": "<string>",
          "credential_id": "<string>",
          "model": "<string>",
          "parameters": {}
        },
        "description": "",
        "enabled": true,
        "timezone": "UTC",
        "ended_at": "2023-11-07T05:31:56Z",
        "stateful": false,
        "permission_mode": "dont_ask",
        "source": "USER",
        "source_session_id": ""
      },
      "id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.agentscope.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

x-user-id
string
required

Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.

Response

Successful Response

Response body for listing schedules.

schedules
ScheduleRecord · object[]
required

Schedule records.

total
integer
required

Total number of schedules.