ELelicit
Research Agent

Stop a Research Agent session

Changed on

Request an asynchronous interrupt using the same stop action as the Elicit web interface.

Stopping does not delete or permanently close the session. The session remains visible and may be continued later. When the response status is stopping, poll the events endpoint until a session_stopped event appears.

The operation is idempotent. If the session is already stopped or failed, it returns the existing state with 200 OK.

Example

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

Request

  • Base URL
    https://elicit.com/api/v2
  • URL
    https://elicit.com/api/v2/sessions/agents/{sessionId}/stop
  • Auth
    HTTP bearer

Path parameters

sessionIdstring uuid required

Response

The session had already stopped or failed.

sessionIdstring required

Unique identifier for the research agent session.

status'stopping' | 'stopped' | 'failed' required

"stopping" when a stop was queued (the session halts asynchronously; poll the events endpoint for the session_stopped event). "stopped" or "failed" when the session had already ended and no stop was needed.

urlstring required

URL to view the session in the Elicit web interface. Only the owner can continue it.

Changes

  • 27c80b9a3470Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 9b5b75b828abRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status