livqenoDocs

API ReferenceOverview

API Reference

One REST API for every SDK and the CLI. Base path /v1.

This is the REST API your backend calls. It's how your server creates rooms and conversations, makes tokens, manages live streams, and reads connection history. You send your project API key with each request.

Do I need this page?

  • Using TypeScript, Python, Go, Java or PHP? You'll mostly use the TypeScript, Python, Go, Java or PHP server SDK. It calls these same endpoints for you. Come here when you want the exact parameters, limits, or errors.
  • Using another language (Go, Ruby, Java, PHP…)? Call these endpoints directly over HTTPS. Every SDK feature is available here.

Where this fits: your backend uses this API to set things up and make tokens. Your app then uses those tokens to connect. See Architecture for the full picture.

The endpoint pages below are generated from the API's code. So they always match what the server really does: each endpoint's credential, rate limit, and parameters.

Where to start

I want to…Read
Learn the base path, error format, and paginationConventions
Create rooms and make tokens for a callRTC API
Create conversations and send messages from my serverChat API
Run a live streamLive Streaming API
Read connection history and errorsObservability API
See every endpoint on one pageAll endpoints

Projects, API keys, teammates, and webhook endpoints are managed in the dashboard or with the CLI.

A first request

From your backend (or your terminal), list the rooms in your project. It's a quick way to check that your key and URL are right:

Terminal
curl "$LIVQENO_API_URL/v1/rooms" \
  -H "Authorization: Bearer $LIVQENO_API_KEY"

A 200 with a JSON body means you're set up. A 401 means the key is wrong or revoked. See API credentials.

Which credential to use

Most of this API is called with your API key. A few chat routes also accept a user's chat token, so they act as that one user:

CredentialHow you send itWho uses it
Project API keyAuthorization: Bearer rvk_<env>_id.secretYour backend. Works for every endpoint here.
Chat tokenAuthorization: Bearer …, or a query parameter on the chat socketA browser or device in a conversation. The Chat API also accepts it, acting as that one user.
RTC tokenA query parameter on the signaling socketA browser or device in a call.

The full model: Authentication.

Next steps

  • Conventions: read this first. It explains the base path, the error format, and paging, which every endpoint shares.
  • Errors: every error code the API returns.
  • Limits & quotas: the limits you'll run into.