FIREANIME API
Browse API97 operations
POST

CreateRoom

Create Room through the Watch Together service.

/api.v1.watch_together.WatchTogetherService/CreateRoom Bearer required
01

Request

CreateWatchTogetherRoomRequest

CreateWatchTogetherRoomRequestapi.v1.watch_together.CreateWatchTogetherRoomRequest4 fields

Create Watch Together Room Request message.

slug
string

Slug value.

season
string

Season value.

episode
string

Episode value.

animeGroupIdoptional
uint32

Anime Group Id value.

Request JSON
{
  "slug": "frieren",
  "season": "1",
  "episode": "1",
  "animeGroupId": 1
}
02

Response

CreateWatchTogetherRoomResponse

CreateWatchTogetherRoomResponseapi.v1.watch_together.CreateWatchTogetherRoomResponse1 fields

Create Watch Together Room Response message.

data
WatchTogetherSnapshot

Data value.

Example response
{
  "data": {
    "room": {
      "publicId": "room-7KQ2",
      "animeId": 1,
      "slug": "frieren",
      "season": "1",
      "episode": "1",
      "animeGroupId": 1,
      "animeTitle": "Frieren: Beyond Journey’s End",
      "episodeTitle": "Frieren: Beyond Journey’s End"
    },
    "members": [
      {
        "userId": 1,
        "username": "fireanime_user",
        "role": "string value",
        "status": "active",
        "isSelf": true
      }
    ]
  }
}
03

Referenced models

3 nested message types

WatchTogetherSnapshotapi.v1.watch_together.WatchTogetherSnapshot2 fields

Watch Together Snapshot message.

room
WatchTogetherRoom

Room value.

membersarray
WatchTogetherMember[]

Members value.

WatchTogetherRoomapi.v1.watch_together.WatchTogetherRoom19 fields

Watch Together Room message.

publicId
string

Public Id value.

animeId
uint32

Anime Id value.

slug
string

Slug value.

season
string

Season value.

episode
string

Episode value.

animeGroupIdoptional
uint32

Anime Group Id value.

animeTitle
string

Anime Title value.

episodeTitle
string

Episode Title value.

hostUserId
uint32

Host User Id value.

status
string

Status value.

playbackState
string

Playback State value.

positionSeconds
int32

Position Seconds value.

positionMax
int32

Position Max value.

playbackUpdatedAt
int64

Playback Updated At value.

createdAt
int64

Created At value.

updatedAt
int64

Updated At value.

expiresAt
int64

Expires At value.

memberCount
int32

Member Count value.

isHost
bool

Is Host value.

WatchTogetherMemberapi.v1.watch_together.WatchTogetherMember5 fields

Watch Together Member message.

userId
uint32

User Id value.

username
string

Username value.

role
string

Role value.

status
string

Status value.

isSelf
bool

Is Self value.

04

Error handling

Common failure codes

unauthenticatedThe Bearer token is missing or invalid.

invalid_argumentThe request payload failed validation.

internalThe service could not complete the operation.