Skip to main content
DELETE
/
conversations
/
{conversation_id}
End conversation
curl --request DELETE \
  --url https://api.spikelabs.com/v1/conversations/{conversation_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "conv_abc123",
  "object": "conversation",
  "personality_id": "<string>",
  "status": "connecting",
  "created_at": "2023-11-07T05:31:56Z",
  "user_id": "<string>",
  "mode": "voice",
  "room_url": "<string>",
  "room_token": "<string>",
  "duration": 123,
  "transcript": [
    {
      "role": "user",
      "content": "<string>",
      "timestamp": 123
    }
  ],
  "ended_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key authentication. Use your secret key (starts with sk_) as a Bearer token.

Path Parameters

conversation_id
string
required

Response

Conversation ended

id
string
required
Example:

"conv_abc123"

object
enum<string>
required
Available options:
conversation
personality_id
string
required
status
enum<string>
required
Available options:
connecting,
active,
ended,
failed
created_at
string<date-time>
required
user_id
string | null
mode
enum<string>
Available options:
voice,
video,
voice_video
room_url
string<uri>

WebRTC room URL

room_token
string

Token to join the room

duration
integer | null

Duration in seconds

transcript
object[] | null
ended_at
string<date-time> | null