Sign in
Research Agent

Get Research Agent session status

Fetch the status and basic metadata of a research-agent session — the typed detail endpoint that an agent item's links.self in GET /api/v2/sessions points to.

Status values

  • processing — The agent is working, or the session is queued and hasn't started.
  • completed — The agent is idle and awaiting input. This is not a terminal state: the session can be continued (agent sessions have no terminal "finished" state).
  • failed — The last turn ended with an error.
  • pausedForInsufficientQuota — The account exceeded its usage limit. The session stays paused until resumed via the links.resume URL (or the Elicit web interface).

No event payload is returned here; use the session's events endpoint for the reduced activity stream.

Example

curl https://elicit.com/api/v2/sessions/agents/{sessionId} \
  -H "Authorization: Bearer elk_live_your_key_here"
get/sessions/agents/{sessionId}

Path parameters

sessionIdstring uuid required

The session ID (UUID) returned by the create endpoints and GET /sessions

Example:5ad08bfb-cbe0-4911-a8c3-309760d33029

The session ID (UUID) returned by the create endpoints and GET /sessions

Response

Research-agent session status and metadata.

type'agent' required

Discriminator identifying this as a research-agent session.

sessionIdstring uuid required

The session ID (UUID) returned by the create endpoints and GET /sessions

status'processing' | 'pausedForInsufficientQuota' | 'completed' | 'failed' | 'unknown' required

Current status of the session: "processing" (running, or not yet started), "completed" (idle and awaiting input — not terminally finished), "failed" (the last turn ended with an error), or "pausedForInsufficientQuota" (paused at the account usage limit; resume once the limit clears).

titlestring required

Human-readable title of the session.

urlstring required

URL to view and continue the session in the Elicit web interface.

source'user' | 'api' | 'mcp' | 'agent_session' required

How the session was created.

createdAtstring required

ISO 8601 timestamp of when the session was created.

isPublicboolean required

Whether the session is publicly accessible via its URL without authentication.

Example response

{
  "sessionId": "5ad08bfb-cbe0-4911-a8c3-309760d33029",
  "source": "api",
  "createdAt": "2025-06-15T14:30:00.000Z",
  "links": {
    "self": "https://elicit.com/api/v2/sessions/reports/5ad08bfb-cbe0-4911-a8c3-309760d33029",
    "resume": "https://elicit.com/api/v2/sessions/5ad08bfb-cbe0-4911-a8c3-309760d33029/resume"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.