PAparley
Sessions

Stop a session

Stop the assistant and any subagents it started, if they are working. What it has already finished is kept, and messages it hasn't read yet are dropped. Returns the session, which is usually idle by then; if it is still working, get it again in a few seconds. Send a message to continue.

post/sessions/{id}/stop

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/sessions/{id}/stop
  • Auth
    HTTP bearer

Path parameters

idstring required

The session ID.

Response

OK

idstring required

The session ID.

titlestring nullable required

The session's title, written by Parley after the first reply unless someone named it, or null until then.

status'working' | 'idle' required

working: Parley's assistant is working, a message is waiting for it, or it is waiting on subagents it started in the background. idle: the assistant has stopped and is waiting for the next message.

origin'web' | 'word' | 'outlook' | 'automation' | 'api' required

Where the session was started: web (Parley's web app, or an email to Parley's assistant), word or outlook (the add-in), automation (an automation run), or api (the REST API, MCP, or the CLI).

urlstring uri required

Where to open the session in Parley.

createdAtstring date-time required

When the session was started.

updatedAtstring date-time required

When the session last changed, such as by a new message.

Changes

No recorded changes to this operation across all 2 revisions of this API.