Skip to main content
PATCH
/
v1
/
session-passes
/
{id}
/
stop
End an equos session. Returns null if already stopped or session was not found.
curl --request PATCH \
  --url https://api.equos.ai/v1/session-passes/{id}/stop \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "organizationId": "<string>",
  "freemium": true,
  "name": "<string>",
  "provider": "<string>",
  "status": "<string>",
  "host": {
    "serverUrl": "<string>"
  },
  "avatar": {
    "id": "<string>",
    "organizationId": "<string>",
    "identity": "<string>",
    "name": "<string>",
    "description": "<string>",
    "thumbnailUrl": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "client": "<string>",
    "agentId": {},
    "agent": {}
  },
  "startedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "client": "<string>",
  "maxDuration": 123,
  "additionalCtx": "<string>",
  "templateVars": {},
  "avatarId": "<string>",
  "agentId": "<string>",
  "agent": {
    "id": "<string>",
    "organizationId": "<string>",
    "provider": "openai",
    "search": true,
    "emotions": true,
    "memory": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "client": "<string>",
    "model": "gemini-2.5-flash-native-audio-preview-09-2025",
    "voice": "Puck",
    "instructions": "<string>",
    "greetingMsg": "<string>",
    "remoteId": "<string>"
  },
  "remoteAgentIdentity": {},
  "transcript": {},
  "endedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Equos Session ID

Response

200 - application/json
​
id
string
required
​
organizationId
string
required
​
freemium
boolean
required
​
name
string
required
​
provider
string
required
​
status
string
required
​
host
object
required
​
avatar
object
required
​
startedAt
string<date-time>
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
client
string
​
maxDuration
number
​
additionalCtx
string
​
templateVars
object
​
avatarId
string
​
agentId
string
​
agent
object
​
remoteAgentIdentity
object
​
transcript
object
​
endedAt
string<date-time>