PAparley
Sessions

Start a session

Start a session with Parley's assistant by sending its first message. The assistant works in the background, as you, with the same tools and access it has in the web app, and the session shows up in your Parley chat history. Returns the session as soon as the message is queued, with status working; get the session until its status is idle, then read the reply with GET /sessions/{id}/messages. Returns 429 USAGE_LIMIT_REACHED when the organization has used its Parley AI allowance for the billing period.

post/sessions

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/sessions
  • Auth
    HTTP bearer

Request body

messagestring required

The first message to Parley's assistant, up to 100,000 characters. The assistant starts on it right away.

projectIdstring

A project to work in, with that project's files, notes, and linked records as context. Leave it out for a session across the organization.

Response

Created.

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.