Session List - AiToEarn Open Platform

GET

/

api

/

agent

/

sessions

Session List

curl --request GET \
  --url https://aitoearn.cn/api/agent/sessions \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://aitoearn.cn/api/agent/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://aitoearn.cn/api/agent/sessions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "code": 0,
  "message": "Request succeeded",
  "data": {
    "page": 1,
    "pageSize": 1,
    "totalPages": 1,
    "total": 1,
    "list": [
      {
        "id": "string",
        "status": "active",
        "points": 1,
        "createdAt": "2026-07-02T12:00:00.000Z",
        "updatedAt": "2026-07-02T12:00:00.000Z",
        "title": "string"
      }
    ]
  }
}

Authorizations

X-Api-Key

string

header

required

Need to get API Key from AiToEarn. Click to go to "API Key Obtaining Tutorial".

Query Parameters

page

integer

default:1

Page number, starting from 1.

Required range: x >= 1

pageSize

integer

default:10

Items per page, from 1 to 1000.

Required range: 1 <= x <= 1000

keyword

string

Search by session title. Length 1-200.

Required string length: 1 - 200

Response

200 - application/json

The request has been processed by the service. Business success is determined by whether the response body has code === 0.

code

integer

required

Business status code. 0 means success; non-zero means a business error.

message

string

required

Response message.

data

object

Hide child attributes

data.page

integer

required

Current page number.

data.pageSize

integer

required

Items per page.

data.totalPages

integer

required

Total pages.

data.total

integer

required

Total item count.

data.list

object[]

required

Data list.

Hide child attributes

data.list.id

string

required

Session ID.

data.list.status

enum<string>

required

Session status. active means running, waiting_approval means waiting for tool approval, waiting_task means waiting for an async task, waiting_resume means waiting to resume, completed means finished, and cancelled means aborted.

Available options:

active,

waiting_approval,

waiting_task,

waiting_resume,

completed,

cancelled

data.list.points

number

required

Credits consumed by this session.

data.list.createdAt

string<date-time>

required

Created at.

data.list.updatedAt

string<date-time>

required

Updated at.

data.list.title

string

Session title. It appears after the title is generated for a new session.

requestId

string

Request ID.

timestamp

integer

Error response timestamp in Unix milliseconds.

Last modified on September 24, 2026

Session List

curl --request GET \
  --url https://aitoearn.cn/api/agent/sessions \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://aitoearn.cn/api/agent/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://aitoearn.cn/api/agent/sessions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "code": 0,
  "message": "Request succeeded",
  "data": {
    "page": 1,
    "pageSize": 1,
    "totalPages": 1,
    "total": 1,
    "list": [
      {
        "id": "string",
        "status": "active",
        "points": 1,
        "createdAt": "2026-07-02T12:00:00.000Z",
        "updatedAt": "2026-07-02T12:00:00.000Z",
        "title": "string"
      }
    ]
  }
}