Docs
API Referencesdks@platform/sdk-live

@platform/sdk-live

Typed TypeScript client for services/live. The page is generated from the SDK package source plus its generated OpenAPI types.

Installation

npm install @platform/sdk-live

You’ll also need the shared auth/client helpers:

npm install @platform/hosts @platform/sdk

Quick start

import { LoopClient } from "@platform/sdk";
import { platformHost, SERVICE_NAMES } from "@platform/hosts";
import { createLiveClient } from "@platform/sdk-live";
 
const loop = new LoopClient({
  clientId: process.env.LOOP_CLIENT_ID!,
  clientSecret: process.env.LOOP_CLIENT_SECRET!,
  redirectUri: "https://your-app.example.com/auth/loop/callback",
});
 
const live = createLiveClient({
  baseUrl: platformHost({ service: SERVICE_NAMES.LIVE }),
  accessToken: tokens.access_token,
});

Use the convenience helpers below when the SDK exposes them, or call the typed endpoint methods directly with GET / POST / PATCH / DELETE.

Convenience helpers

cancelRegistration

Underlying REST endpoint: DELETE /v1/sessions/\{id\}/registrations/me

Parameters

  • sessionId: string

Return type

Promise<Result<{ cancelled: true }>>

Example

const result = await live.cancelRegistration("<sessionId>");

createShareToken

Underlying REST endpoint: POST /v1/sessions/\{id\}/share-token

Parameters

  • sessionId: string

Return type

Promise<Result<{ share_token: string }>>

Example

const result = await live.createShareToken("<sessionId>");

deleteQuestion

Underlying REST endpoint: DELETE /v1/questions/\{id\}

Parameters

  • questionId: string

Return type

Promise<Result<{ deleted: true }>>

Example

const result = await live.deleteQuestion("<questionId>");

getModerationLog

Underlying REST endpoint: GET /v1/sessions/\{id\}/moderation-log

Parameters

  • sessionId: string
  • limit?: number

Return type

Promise<Result<ModerationLogEntry[]>>

Example

const result = await live.getModerationLog("<sessionId>", 123);

getMyRegistration

Underlying REST endpoint: GET /v1/sessions/\{id\}/registrations/me

Parameters

  • sessionId: string

Return type

Promise<Result<MyRegistration>>

Example

const result = await live.getMyRegistration("<sessionId>");

getRegistrationCount

Underlying REST endpoint: GET /v1/sessions/\{id\}/registrations/count

Parameters

  • sessionId: string

Return type

Promise<Result<RegistrationCount>>

Example

const result = await live.getRegistrationCount("<sessionId>");

getReplayByToken

Underlying REST endpoint: GET /v1/replays/by-token/\{token\}

Parameters

  • token: string

Return type

Promise<Result<ReplayByToken>>

Example

const result = await live.getReplayByToken("<token>");

getStreamChatToken

Underlying REST endpoint: GET /v1/sessions/\{id\}/chat-token

Parameters

  • sessionId: string

Return type

Promise<Result<ChatTokenBundle>>

Example

const result = await live.getStreamChatToken("<sessionId>");

listLivesByHost

Underlying REST endpoint: GET /v1/sessions

Parameters

  • opts: ListLivesByHostOpts

Return type

Promise<Result<SessionPage>>

Example

const result = await live.listLivesByHost({
  /* ListLivesByHostOpts */
});

listQuestions

Underlying REST endpoint: GET /v1/sessions/\{id\}/questions

Parameters

  • sessionId: string
  • opts?: ListQuestionsOpts

Return type

Promise<Result<Question[]>>

Example

const result = await live.listQuestions("<sessionId>", {
  /* ListQuestionsOpts */
});

listReactions

Underlying REST endpoint: GET /v1/sessions/\{id\}/reactions

Parameters

  • sessionId: string
  • limit?: number

Return type

Promise<Result<Reaction[]>>

Example

const result = await live.listReactions("<sessionId>", 123);

listReplays

Underlying REST endpoint: GET /v1/sessions

Parameters

  • opts?: ListSessionsOpts

Return type

Promise<LiveSessionListResult>

Example

const result = await live.listReplays({
  /* ListSessionsOpts */
});

listUpcomingLives

Underlying REST endpoint: GET /v1/sessions

Parameters

  • opts?: ListSessionsOpts

Return type

Promise<LiveSessionListResult>

Example

const result = await live.listUpcomingLives({
  /* ListSessionsOpts */
});

listUpcomingLivesByCommunity

Underlying REST endpoint: GET /v1/sessions

Parameters

  • opts: ListLivesByCommunityOpts

Return type

Promise<LiveSessionListResult>

Example

const result = await live.listUpcomingLivesByCommunity({
  /* ListLivesByCommunityOpts */
});

moderateQuestion

Underlying REST endpoint: PATCH /v1/questions/\{id\}/status

Parameters

  • questionId: string
  • status: ModerationStatus

Return type

Promise<Result<Question>>

Example

const result = await live.moderateQuestion("<questionId>", {
  /* ModerationStatus */
});

registerForSession

Underlying REST endpoint: POST /v1/sessions/\{id\}/registrations

Parameters

  • sessionId: string

Return type

Promise<Result<SessionRegistration>>

Example

const result = await live.registerForSession("<sessionId>");

registerGuest

Underlying REST endpoint: POST /v1/public/sessions/\{id\}/register

Parameters

  • sessionId: string
  • opts: RegisterGuestOpts

Return type

Promise<Result<PublicRegistration>>

Example

const result = await live.registerGuest("<sessionId>", {
  /* RegisterGuestOpts */
});

sendReaction

Underlying REST endpoint: POST /v1/sessions/\{id\}/reactions

Parameters

  • sessionId: string
  • type: ReactionType

Return type

Promise<Result<{ id: string }>>

Example

const result = await live.sendReaction("<sessionId>", {
  /* ReactionType */
});

setQuestionStatus

Underlying REST endpoint: PATCH /v1/sessions/\{id\}/questions/\{qid\}

Parameters

  • sessionId: string
  • questionId: string
  • status: ModerationStatus

Return type

Promise<Result<Question>>

Example

const result = await live.setQuestionStatus("<sessionId>", "<questionId>", {
  /* ModerationStatus */
});

stageAction

Underlying REST endpoint: POST /v1/sessions/\{id\}/stage

Parameters

  • sessionId: string
  • targetUserId: string
  • action: StageAction

Return type

Promise<Result<StageResult>>

Example

const result = await live.stageAction("<sessionId>", "<targetUserId>", {
  /* StageAction */
});

submitQuestion

Underlying REST endpoint: POST /v1/sessions/\{id\}/questions

Parameters

  • sessionId: string
  • body: string

Return type

Promise<Result<Question>>

Example

const result = await live.submitQuestion("<sessionId>", "<body>");

voteQuestion

Underlying REST endpoint: POST /v1/questions/\{id\}/vote

Parameters

  • questionId: string

Return type

Promise<Result<QuestionVoteResult>>

Example

const result = await live.voteQuestion("<questionId>");

Endpoint calls

GET /readyz

Underlying REST endpoint: GET /readyz

Parameters

None

Return type

Promise<{
  data?: paths["/readyz"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.GET("/readyz");

GET /v1/admin/sessions

Underlying REST endpoint: GET /v1/admin/sessions

Parameters

  • query?: paths["/v1/admin/sessions"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/admin/sessions"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.GET("/v1/admin/sessions", {
  params: {
    query: {
      /* paths["/v1/admin/sessions"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/admin/sessions

Underlying REST endpoint: POST /v1/admin/sessions

Parameters

  • body: paths["/v1/admin/sessions"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/admin/sessions"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/v1/admin/sessions", {
  body: {
    /* paths["/v1/admin/sessions"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

DELETE /v1/admin/sessions/{id}

Underlying REST endpoint: DELETE /v1/admin/sessions/\{id\}

Parameters

  • path: paths["/v1/admin/sessions/{id}"]["delete"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/admin/sessions/{id}"]["delete"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.DELETE("/v1/admin/sessions/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

GET /v1/admin/sessions/{id}

Underlying REST endpoint: GET /v1/admin/sessions/\{id\}

Parameters

  • path: paths["/v1/admin/sessions/{id}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/admin/sessions/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.GET("/v1/admin/sessions/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

PATCH /v1/admin/sessions/{id}

Underlying REST endpoint: PATCH /v1/admin/sessions/\{id\}

Parameters

  • path: paths["/v1/admin/sessions/{id}"]["patch"]["parameters"]["path"]
  • body: paths["/v1/admin/sessions/{id}"]["patch"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/admin/sessions/{id}"]["patch"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.PATCH("/v1/admin/sessions/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/admin/sessions/{id}"]["patch"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/admin/sessions/{id}/registrations

Underlying REST endpoint: GET /v1/admin/sessions/\{id\}/registrations

Parameters

  • path: paths["/v1/admin/sessions/{id}/registrations"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/admin/sessions/{id}/registrations"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.GET("/v1/admin/sessions/{id}/registrations", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/live/calls

Underlying REST endpoint: POST /v1/live/calls

Parameters

  • body: paths["/v1/live/calls"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/live/calls"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/v1/live/calls", {
  body: {
    /* paths["/v1/live/calls"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/live/calls/{id}

Underlying REST endpoint: GET /v1/live/calls/\{id\}

Parameters

  • path: paths["/v1/live/calls/{id}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/live/calls/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.GET("/v1/live/calls/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/live/calls/{id}/end

Underlying REST endpoint: POST /v1/live/calls/\{id\}/end

Parameters

  • path: paths["/v1/live/calls/{id}/end"]["post"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/live/calls/{id}/end"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/v1/live/calls/{id}/end", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/live/calls/{id}/token

Underlying REST endpoint: POST /v1/live/calls/\{id\}/token

Parameters

  • path: paths["/v1/live/calls/{id}/token"]["post"]["parameters"]["path"]
  • body: paths["/v1/live/calls/{id}/token"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/live/calls/{id}/token"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/v1/live/calls/{id}/token", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/live/calls/{id}/token"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/live/sessions

Underlying REST endpoint: GET /v1/live/sessions

Parameters

  • query?: paths["/v1/live/sessions"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/live/sessions"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.GET("/v1/live/sessions", {
  params: {
    query: {
      /* paths["/v1/live/sessions"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/public/sessions/{id}/register

Underlying REST endpoint: POST /v1/public/sessions/\{id\}/register

Parameters

  • path: paths["/v1/public/sessions/{id}/register"]["post"]["parameters"]["path"]
  • body: paths["/v1/public/sessions/{id}/register"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/public/sessions/{id}/register"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/v1/public/sessions/{id}/register", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/public/sessions/{id}/register"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

DELETE /v1/questions/{id}

Underlying REST endpoint: DELETE /v1/questions/\{id\}

Parameters

  • path: paths["/v1/questions/{id}"]["delete"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/questions/{id}"]["delete"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.DELETE("/v1/questions/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

PATCH /v1/questions/{id}/status

Underlying REST endpoint: PATCH /v1/questions/\{id\}/status

Parameters

  • path: paths["/v1/questions/{id}/status"]["patch"]["parameters"]["path"]
  • body: paths["/v1/questions/{id}/status"]["patch"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/questions/{id}/status"]["patch"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.PATCH("/v1/questions/{id}/status", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/questions/{id}/status"]["patch"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/questions/{id}/vote

Underlying REST endpoint: POST /v1/questions/\{id\}/vote

Parameters

  • path: paths["/v1/questions/{id}/vote"]["post"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/questions/{id}/vote"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/v1/questions/{id}/vote", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

GET /v1/replays/by-token/{token}

Underlying REST endpoint: GET /v1/replays/by-token/\{token\}

Parameters

  • path: paths["/v1/replays/by-token/{token}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/replays/by-token/{token}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.GET("/v1/replays/by-token/{token}", {
  params: {
    path: {
      token: "<token>",
    },
  },
});

GET /v1/sessions

Underlying REST endpoint: GET /v1/sessions

Parameters

  • query?: paths["/v1/sessions"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/sessions"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.GET("/v1/sessions", {
  params: {
    query: {
      /* paths["/v1/sessions"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/sessions

Underlying REST endpoint: POST /v1/sessions

Parameters

  • body: paths["/v1/sessions"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/sessions"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/v1/sessions", {
  body: {
    /* paths["/v1/sessions"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

DELETE /v1/sessions/{id}

Underlying REST endpoint: DELETE /v1/sessions/\{id\}

Parameters

  • path: paths["/v1/sessions/{id}"]["delete"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}"]["delete"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.DELETE("/v1/sessions/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

GET /v1/sessions/{id}

Underlying REST endpoint: GET /v1/sessions/\{id\}

Parameters

  • path: paths["/v1/sessions/{id}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.GET("/v1/sessions/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

PATCH /v1/sessions/{id}

Underlying REST endpoint: PATCH /v1/sessions/\{id\}

Parameters

  • path: paths["/v1/sessions/{id}"]["patch"]["parameters"]["path"]
  • body: paths["/v1/sessions/{id}"]["patch"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}"]["patch"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.PATCH("/v1/sessions/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/sessions/{id}"]["patch"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/sessions/{id}/chat-token

Underlying REST endpoint: GET /v1/sessions/\{id\}/chat-token

Parameters

  • path: paths["/v1/sessions/{id}/chat-token"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/chat-token"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.GET("/v1/sessions/{id}/chat-token", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/sessions/{id}/host

Underlying REST endpoint: POST /v1/sessions/\{id\}/host

Parameters

  • path: paths["/v1/sessions/{id}/host"]["post"]["parameters"]["path"]
  • body: paths["/v1/sessions/{id}/host"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/host"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/v1/sessions/{id}/host", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/sessions/{id}/host"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/sessions/{id}/join

Underlying REST endpoint: POST /v1/sessions/\{id\}/join

Parameters

  • path: paths["/v1/sessions/{id}/join"]["post"]["parameters"]["path"]
  • body: paths["/v1/sessions/{id}/join"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/join"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/v1/sessions/{id}/join", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/sessions/{id}/join"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/sessions/{id}/moderation-log

Underlying REST endpoint: GET /v1/sessions/\{id\}/moderation-log

Parameters

  • path: paths["/v1/sessions/{id}/moderation-log"]["get"]["parameters"]["path"]
  • query?: paths["/v1/sessions/{id}/moderation-log"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/moderation-log"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.GET("/v1/sessions/{id}/moderation-log", {
  params: {
    path: {
      id: "<id>",
    },
    query: {
      /* paths["/v1/sessions/{id}/moderation-log"]["get"]["parameters"]["query"] */
    },
  },
});

GET /v1/sessions/{id}/questions

Underlying REST endpoint: GET /v1/sessions/\{id\}/questions

Parameters

  • path: paths["/v1/sessions/{id}/questions"]["get"]["parameters"]["path"]
  • query?: paths["/v1/sessions/{id}/questions"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/questions"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.GET("/v1/sessions/{id}/questions", {
  params: {
    path: {
      id: "<id>",
    },
    query: {
      /* paths["/v1/sessions/{id}/questions"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/sessions/{id}/questions

Underlying REST endpoint: POST /v1/sessions/\{id\}/questions

Parameters

  • path: paths["/v1/sessions/{id}/questions"]["post"]["parameters"]["path"]
  • body: paths["/v1/sessions/{id}/questions"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/questions"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/v1/sessions/{id}/questions", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/sessions/{id}/questions"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

PATCH /v1/sessions/{id}/questions/{qid}

Underlying REST endpoint: PATCH /v1/sessions/\{id\}/questions/\{qid\}

Parameters

  • path: paths["/v1/sessions/{id}/questions/{qid}"]["patch"]["parameters"]["path"]
  • body: paths["/v1/sessions/{id}/questions/{qid}"]["patch"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/questions/{qid}"]["patch"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.PATCH("/v1/sessions/{id}/questions/{qid}", {
  params: {
    path: {
      id: "<id>",
      qid: "<qid>",
    },
  },
  body: {
    /* paths["/v1/sessions/{id}/questions/{qid}"]["patch"]["requestBody"]["content"]["application/json"] */
  },
});

GET /v1/sessions/{id}/reactions

Underlying REST endpoint: GET /v1/sessions/\{id\}/reactions

Parameters

  • path: paths["/v1/sessions/{id}/reactions"]["get"]["parameters"]["path"]
  • query?: paths["/v1/sessions/{id}/reactions"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/reactions"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.GET("/v1/sessions/{id}/reactions", {
  params: {
    path: {
      id: "<id>",
    },
    query: {
      /* paths["/v1/sessions/{id}/reactions"]["get"]["parameters"]["query"] */
    },
  },
});

POST /v1/sessions/{id}/reactions

Underlying REST endpoint: POST /v1/sessions/\{id\}/reactions

Parameters

  • path: paths["/v1/sessions/{id}/reactions"]["post"]["parameters"]["path"]
  • body: paths["/v1/sessions/{id}/reactions"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/reactions"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/v1/sessions/{id}/reactions", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/sessions/{id}/reactions"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/sessions/{id}/register

Underlying REST endpoint: POST /v1/sessions/\{id\}/register

Parameters

  • path: paths["/v1/sessions/{id}/register"]["post"]["parameters"]["path"]
  • body: paths["/v1/sessions/{id}/register"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/register"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/v1/sessions/{id}/register", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/sessions/{id}/register"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/sessions/{id}/registrations

Underlying REST endpoint: POST /v1/sessions/\{id\}/registrations

Parameters

  • path: paths["/v1/sessions/{id}/registrations"]["post"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/registrations"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/v1/sessions/{id}/registrations", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

GET /v1/sessions/{id}/registrations/count

Underlying REST endpoint: GET /v1/sessions/\{id\}/registrations/count

Parameters

  • path: paths["/v1/sessions/{id}/registrations/count"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/registrations/count"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.GET("/v1/sessions/{id}/registrations/count", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

DELETE /v1/sessions/{id}/registrations/me

Underlying REST endpoint: DELETE /v1/sessions/\{id\}/registrations/me

Parameters

  • path: paths["/v1/sessions/{id}/registrations/me"]["delete"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/registrations/me"]["delete"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.DELETE("/v1/sessions/{id}/registrations/me", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

GET /v1/sessions/{id}/registrations/me

Underlying REST endpoint: GET /v1/sessions/\{id\}/registrations/me

Parameters

  • path: paths["/v1/sessions/{id}/registrations/me"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/registrations/me"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.GET("/v1/sessions/{id}/registrations/me", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/sessions/{id}/share-token

Underlying REST endpoint: POST /v1/sessions/\{id\}/share-token

Parameters

  • path: paths["/v1/sessions/{id}/share-token"]["post"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/share-token"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/v1/sessions/{id}/share-token", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

POST /v1/sessions/{id}/stage

Underlying REST endpoint: POST /v1/sessions/\{id\}/stage

Parameters

  • path: paths["/v1/sessions/{id}/stage"]["post"]["parameters"]["path"]
  • body: paths["/v1/sessions/{id}/stage"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/sessions/{id}/stage"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/v1/sessions/{id}/stage", {
  params: {
    path: {
      id: "<id>",
    },
  },
  body: {
    /* paths["/v1/sessions/{id}/stage"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /webhooks/stream

Underlying REST endpoint: POST /webhooks/stream

Parameters

  • body: paths["/webhooks/stream"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/webhooks/stream"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await live.POST("/webhooks/stream", {
  body: {
    /* paths["/webhooks/stream"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

Related

@platform/sdk-jobs@platform/sdk-membership