RestRequest

RestRequest = object

Defined in: packages/core/src/rest/types.ts:12

Describes an outgoing HTTP request to a platform API.

Precondition

path is a relative path (e.g., “/videos”)

Postcondition

query values are URL-encoded by the RestManager

Properties

body?

optional body: unknown

Defined in: packages/core/src/rest/types.ts:16

---

bodyType?

optional bodyType: "json" | "raw"

Defined in: packages/core/src/rest/types.ts:22

Body serialization format.

• “json” (default): JSON.stringify the body and set Content-Type: application/json
• “raw”: pass body directly to fetch (e.g., for FormData, URLSearchParams, ReadableStream)

---

bucketId?

optional bucketId: string

Defined in: packages/core/src/rest/types.ts:27

Rate limit bucket key (e.g., “videos:list”, “search:list”).

---

headers?

optional headers: Record<string, string>

Defined in: packages/core/src/rest/types.ts:23

---

method

method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE"

Defined in: packages/core/src/rest/types.ts:13

---

path

path: string

Defined in: packages/core/src/rest/types.ts:14

---

query?

optional query: Record<string, string | string[]>

Defined in: packages/core/src/rest/types.ts:15

---

signal?

optional signal: AbortSignal

Defined in: packages/core/src/rest/types.ts:25

AbortSignal to cancel the request.