Skip to main content
PATCH
/
v1
/
sessions
/
{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/sessions/{id}/stop \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "organizationId": "<string>",
  "freemium": true,
  "name": "<string>",
  "provider": "<string>",
  "client": "<string>",
  "status": "<string>",
  "maxDuration": 123,
  "host": {
    "serverUrl": "<string>"
  },
  "avatarId": "<string>",
  "avatar": {
    "id": "<string>",
    "organizationId": "<string>",
    "identity": "<string>",
    "name": "<string>",
    "client": "<string>",
    "thumbnailUrl": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "agentId": "<string>",
  "agent": {
    "id": "<string>",
    "organizationId": "<string>",
    "name": "<string>",
    "provider": "openai",
    "client": "<string>",
    "config": {
      "instructions": "<string>",
      "model": "gpt-4o-realtime-preview",
      "voice": "alloy"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "startedAt": "2023-11-07T05:31:56Z",
  "endedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

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
avatarId
string
agentId
string
agent
object
endedAt
string<date-time>
I