GET
/
v1
/
sessions

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
Start New SessionGet Session