GET
/
v1
/
sessions
curl --request GET \
  --url https://api.allyson.ai/v1/sessions \
  --header 'x-api-key: <api-key>'
{
  "sessions": [
    {
      "cost": 123,
      "files": [
        {
          "filename": "<string>",
          "signedUrl": "<string>",
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "name": "<string>",
      "sessionId": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "status": "active",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "currentPage": 123,
  "totalPages": 123,
  "totalSessions": 123
}

Authorizations

​
x-api-key
string
header
required

Add your API key from app.allyson.ai/api to the x-api-key header.

Query Parameters

​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
limit
integer
default:10

Number of items per page

Required range: x >= 1
​
status
enum<string>

Filter sessions by status:

  • active: Session is currently running and processing
  • inactive: Session is paused or temporarily stopped
  • completed: Session has finished successfully
  • failed: Session encountered an error and stopped
  • humanInput: Session is waiting for human interaction
Available options:
active,
inactive,
completed,
failed,
humanInput,
stopped

Response

200
application/json
Successful Response
​
sessions
object[]
required
​
currentPage
integer
required
​
totalPages
integer
required
​
totalSessions
integer
required