livqenoDocs

ConceptsProject

Project

A container for your app. Every room, conversation, key, and quota belongs to one project.

A project is a container for one app. Every room, conversation, key, and webhook you create belongs to exactly one project, and projects never share data with each other.

A project is the first thing you create, before any key or token. In the overall flow it sits at the very start:

Project → API key → your backend mints a token → your app joins → webhooks.

Why it exists

Every time your backend calls Livqeno, Livqeno needs to answer three questions:

  1. Whose room is this?
  2. Whose data is this?
  3. Whose limits apply?

The project answers all three.

You never send a project id with a request. The project comes from the API key your backend sends. Livqeno trusts the key, because only you have it. It doesn't trust fields in a request body, because anyone can write those.

When to create a project

Create one project per app. For example:

SituationProjects
One telehealth app with web and mobile clients1 project. Web and mobile share rooms and conversations.
Two separate products (a support tool and a gaming app)2 projects. Their data and keys stay apart.
Testing vs. real users of the same app1 project. Use its environments, not a second project.

What belongs to a project

  • Rooms, conversations, and live streams
  • API keys and webhook endpoints
  • Connections, error events, and audit entries
  • Usage

Names belong to the project too. Two projects can both have a room called support, and they are different rooms.

What doesn't

The project itself: its name, and who manages it. Who can manage it (add keys, see data) is set by roles. See Roles & permissions.

Example

In your terminal, with the CLI, create a project and check that it's there:

Terminal
livqeno projects create my-video-app
livqeno projects list

On your backend, you can read the project your API key belongs to. You don't pass an id, because the key already tells Livqeno which project it is:

// Your backend's own project, resolved from the API key it holds.
const project = await livqeno.projects.get();

Next steps

  1. Create a project: step by step, in the dashboard or the CLI.
  2. Environment: every project has three. Learn why.
  3. API key: the credential your backend uses for the project.