livqenoDocs

API ReferenceAll endpoints

All endpoints

Every endpoint your backend can call, generated from the API's controllers.

This is every endpoint your backend can call: 125 in total, all under /v1. Use it to find the right endpoint quickly, then follow the link to its reference page for parameters and examples.

  • Call them with a project API key.
  • Chat endpoints also accept a chat token (acting as one user).
  • This list is generated from the API code, so it is always up to date.

Setting up projects, API keys, teammates, and webhooks? Use the dashboard or the CLI instead.

MethodPathCredentialReference
DELETE/v1/agents/{id}Project API keyAI
GET/v1/agents/{id}Project API keyAI
PATCH/v1/agents/{id}Project API keyAI
POST/v1/agents/{id}/interruptProject API keyAI
POST/v1/agents/{id}/sayProject API keyAI
POST/v1/chat/attachments/{attachmentId}/completeProject API key or chat tokenChat
GET/v1/chat/attachments/{attachmentId}/download-urlProject API key or chat tokenChat
GET/v1/chat/bansProject API key or chat tokenChat
POST/v1/chat/bansProject API key or chat tokenChat
DELETE/v1/chat/bans/{userId}Project API key or chat tokenChat
GET/v1/chat/conversationsProject API key or chat tokenChat
POST/v1/chat/conversationsProject API key or chat tokenChat
DELETE/v1/chat/conversations/{room}Project API key or chat tokenChat
GET/v1/chat/conversations/{room}Project API key or chat tokenChat
PATCH/v1/chat/conversations/{room}Project API key or chat tokenChat
POST/v1/chat/conversations/{room}/attachmentsProject API key or chat tokenChat
GET/v1/chat/conversations/{room}/bansProject API key or chat tokenChat
POST/v1/chat/conversations/{room}/bansProject API key or chat tokenChat
DELETE/v1/chat/conversations/{room}/bans/{userId}Project API key or chat tokenChat
GET/v1/chat/conversations/{room}/eventsProject API key or chat tokenChat
POST/v1/chat/conversations/{room}/leaveProject API key or chat tokenChat
GET/v1/chat/conversations/{room}/membersProject API key or chat tokenChat
POST/v1/chat/conversations/{room}/membersProject API key or chat tokenChat
DELETE/v1/chat/conversations/{room}/members/{userId}Project API key or chat tokenChat
GET/v1/chat/conversations/{room}/members/{userId}/last-seenProject API key or chat tokenChat
GET/v1/chat/conversations/{room}/messagesProject API key or chat tokenChat
POST/v1/chat/conversations/{room}/messagesProject API key or chat tokenChat
GET/v1/chat/conversations/{room}/mutesProject API key or chat tokenChat
POST/v1/chat/conversations/{room}/mutesProject API key or chat tokenChat
DELETE/v1/chat/conversations/{room}/mutes/{userId}Project API key or chat tokenChat
GET/v1/chat/conversations/{room}/pinsProject API key or chat tokenChat
GET/v1/chat/conversations/{room}/presenceProject API key or chat tokenChat
GET/v1/chat/conversations/{room}/read-receiptsProject API key or chat tokenChat
GET/v1/chat/conversations/{room}/read-stateProject API key or chat tokenChat
GET/v1/chat/conversations/{room}/searchProject API key or chat tokenChat
GET/v1/chat/conversations/{room}/typingProject API key or chat tokenChat
GET/v1/chat/flagsProject API key or chat tokenChat
PATCH/v1/chat/flags/{flagId}Project API key or chat tokenChat
GET/v1/chat/me/blocksProject API key or chat tokenChat
DELETE/v1/chat/me/blocks/{userId}Project API key or chat tokenChat
POST/v1/chat/me/blocks/{userId}Project API key or chat tokenChat
GET/v1/chat/me/conversationsProject API key or chat tokenChat
PATCH/v1/chat/me/conversations/{room}Project API key or chat tokenChat
GET/v1/chat/me/devicesProject API key or chat tokenChat
POST/v1/chat/me/devicesProject API key or chat tokenChat
DELETE/v1/chat/me/devices/{token}Project API key or chat tokenChat
DELETE/v1/chat/messages/{messageId}Project API key or chat tokenChat
GET/v1/chat/messages/{messageId}Project API key or chat tokenChat
PATCH/v1/chat/messages/{messageId}Project API key or chat tokenChat
POST/v1/chat/messages/{messageId}/flagsProject API key or chat tokenChat
DELETE/v1/chat/messages/{messageId}/pinProject API key or chat tokenChat
POST/v1/chat/messages/{messageId}/pinProject API key or chat tokenChat
POST/v1/chat/messages/{messageId}/reactionsProject API key or chat tokenChat
DELETE/v1/chat/messages/{messageId}/reactions/{emoji}Project API key or chat tokenChat
POST/v1/chat/messages/{messageId}/readProject API key or chat tokenChat
GET/v1/chat/messages/{messageId}/revisionsProject API key or chat tokenChat
GET/v1/chat/messages/{messageId}/threadProject API key or chat tokenChat
GET/v1/chat/mutesProject API key or chat tokenChat
POST/v1/chat/mutesProject API key or chat tokenChat
DELETE/v1/chat/mutes/{userId}Project API key or chat tokenChat
GET/v1/chat/searchProject API key or chat tokenChat
POST/v1/chat/tokensProject API key or chat tokenChat
DELETE/v1/chat/tokens/{tokenId}Project API key or chat tokenChat
GET/v1/chat/users/{userId}/blocksProject API key or chat tokenChat
DELETE/v1/chat/users/{userId}/blocks/{blockedId}Project API key or chat tokenChat
POST/v1/chat/users/{userId}/blocks/{blockedId}Project API key or chat tokenChat
DELETE/v1/chat/users/{userId}/dataProject API key or chat tokenChat
GET/v1/chat/users/{userId}/exportProject API key or chat tokenChat
GET/v1/connectionsProject API keyObservability
GET/v1/connections/{connectionId}Project API keyObservability
GET/v1/diagnosticsProject API keyObservability
GET/v1/errorsProject API keyObservability
GET/v1/errors/{errorId}Project API keyObservability
GET/v1/live-streamsProject API keyLive Streaming
POST/v1/live-streamsProject API keyLive Streaming
GET/v1/live-streams/{streamId}Project API keyLive Streaming
PATCH/v1/live-streams/{streamId}Project API keyLive Streaming
POST/v1/live-streams/{streamId}/endProject API keyLive Streaming
POST/v1/live-streams/{streamId}/hostsProject API keyLive Streaming
DELETE/v1/live-streams/{streamId}/hosts/{identity}Project API keyLive Streaming
DELETE/v1/live-streams/{streamId}/ingressProject API keyLive Streaming
GET/v1/live-streams/{streamId}/ingressProject API keyLive Streaming
POST/v1/live-streams/{streamId}/ingressProject API keyLive Streaming
POST/v1/live-streams/{streamId}/ingress/resetProject API keyLive Streaming
POST/v1/live-streams/{streamId}/leaveProject API keyLive Streaming
GET/v1/live-streams/{streamId}/playbackProject API keyLive Streaming
GET/v1/live-streams/{streamId}/restreamsProject API keyLive Streaming
POST/v1/live-streams/{streamId}/restreamsProject API keyLive Streaming
DELETE/v1/live-streams/{streamId}/restreams/{restreamId}Project API keyLive Streaming
PATCH/v1/live-streams/{streamId}/restreams/{restreamId}Project API keyLive Streaming
POST/v1/live-streams/{streamId}/stage/demoteProject API keyLive Streaming
POST/v1/live-streams/{streamId}/stage/invitesProject API keyLive Streaming
POST/v1/live-streams/{streamId}/stage/promoteProject API keyLive Streaming
POST/v1/live-streams/{streamId}/startProject API keyLive Streaming
POST/v1/live-streams/{streamId}/viewer-tokensProject API keyLive Streaming
GET/v1/metricsProject API keyObservability
GET/v1/projectProject API keyObservability
DELETE/v1/recording-storageProject API keyObservability
GET/v1/recording-storageProject API keyObservability
PUT/v1/recording-storageProject API keyObservability
GET/v1/recordings/{recordingId}Project API keyObservability
POST/v1/recordings/{recordingId}/stopProject API keyObservability
GET/v1/roomsProject API keyRTC
POST/v1/roomsProject API keyRTC
DELETE/v1/rooms/{id}Project API keyRTC
GET/v1/rooms/{id}Project API keyRTC
GET/v1/rooms/{id}/participantsProject API keyRTC
GET/v1/rooms/{roomId}/agentsProject API keyAI
POST/v1/rooms/{roomId}/agentsProject API keyAI
POST/v1/rooms/{roomId}/dataProject API keyRTC
PATCH/v1/rooms/{roomId}/participants/{identity}Project API keyRTC
POST/v1/rooms/{roomId}/participants/{identity}/muteProject API keyRTC
PATCH/v1/rooms/{roomId}/participants/{identity}/permissionsProject API keyRTC
POST/v1/rooms/{roomId}/participants/{identity}/removeProject API keyRTC
GET/v1/rooms/{roomId}/recordingsProject API keyRTC
POST/v1/rooms/{roomId}/recordingsProject API keyRTC
POST/v1/rooms/{roomId}/rtc-tokensProject API keyRTC
DELETE/v1/rooms/{roomId}/rtc-tokens/{tokenId}Project API keyRTC
DELETE/v1/rooms/{roomId}/transcriptionProject API keyAI
GET/v1/rooms/{roomId}/transcriptionProject API keyAI
POST/v1/rooms/{roomId}/transcriptionProject API keyAI
GET/v1/transcripts/{id}Project API keyAI
GET/v1/transcripts/{id}.txtProject API keyAI
GET/v1/transcripts/{id}.vttProject API keyAI
DELETE/v1/transcripts/participants/{identity}Project API keyAI

Next steps

Edit this page on GitHub