List sessions
List sessions with filters for time, source, service, handler, automation, and attribution.
| Method | Path | Required permissions |
|---|---|---|
| GET | /v1/sessions | read:sessions |
- API key
- Supported.
- CLI user token
- Supported.
- Sandbox token
- Requires the ellipsis:api scope and the required grants in the token's permissions.ellipsis configuration.
Higher permission levels include lower levels: read < write < delete.
Grant match patterns can further restrict access to individual resources.
Query parameters
An automation id, or its name: only sessions that automation started.
Service that triggered the session. Includes built-in responders and legacy sessions without a saved handler.
slackgithublinearsentrySaved handler id captured when the session started.
50integerA GitHub account id (see GET /v1/integrations/github/members); scopes the list to sessions attributed to that developer.
"owner/name" (exact) or a bare repo name. Sessions whose repository is named only inside their automation , dashboard starts, cron , do not match.
falsebooleanKeep only sessions whose conversation is still going , live or idle , dropping the ones that completed, errored, or were stopped or cancelled. A session parked between turns counts as unfinished.
falsebooleancurl "https://api.ellipsis.dev/v1/sessions" \
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN"import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
for item in client.sessions.list():
print(item)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
for await (const item of await client.sessions.list()) {
console.log(item);
}