Skip to main content
GET
/
background-tasks
/
{session_id}
List running background tasks for a session
curl --request GET \
  --url https://api.example.com/background-tasks/{session_id} \
  --header 'x-user-id: <x-user-id>'
{
  "tasks": [
    {
      "task_id": "<string>",
      "session_id": "<string>",
      "agent_id": "<string>"
    }
  ],
  "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.

Path Parameters

​
session_id
string
required

Response

Successful Response

Response body for listing background tasks of a session.

​
tasks
BackgroundTaskInfo · object[]
required

Running background tasks for the requested session.

​
total
integer
required

Total number of running tasks.