GET /v1/rooms

The GET /v1/rooms endpoint allows you to list all the rooms associated with your account.

HTTP Method

GET

URL

https://api.nomi.ai/v1/rooms

Response Body Format

{
  rooms: Array<{
    uuid: UUID;
    name: string;
    created: ISODateString;
    updated: ISODateString;
    status: "Creating" | "Default" | "Waiting" | "Typing" | "Error" | "InitialNoteError" | "Manual" | "TranscriptionError;
    backchannelingEnabled: boolean;
    nomis: Array<{
      uuid: UUID;
      gender: "Male" | "Female" | "Non Binary";
      name: string;
      created: ISODateString;
      relationshipType: "Mentor" | "Friend" | "Romantic";
    }>;
    note: string;
  }>;
}