API Reference

Realtime Kit

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Apps

Fetch all apps

client.realtimeKit.apps.get(AppGetParams { account_id, page_no, per_page, 2 more } params, RequestOptionsoptions?): AppGetResponse { data, paging, success }

GET/accounts/{account_id}/realtime/kit/apps

Fetch app details

client.realtimeKit.apps.getAppByID(stringappID, AppGetAppByIDParams { account_id } params, RequestOptionsoptions?): AppGetAppByIDResponse { data, success }

GET/accounts/{account_id}/realtime/kit/apps/{app_id}

Update an app

client.realtimeKit.apps.updateAppByID(stringappID, AppUpdateAppByIDParams { account_id, name } params, RequestOptionsoptions?): AppUpdateAppByIDResponse { data, success }

PATCH/accounts/{account_id}/realtime/kit/apps/{app_id}

Create App

client.realtimeKit.apps.post(AppPostParams { account_id, name } params, RequestOptionsoptions?): AppPostResponse { data, success }

POST/accounts/{account_id}/realtime/kit/apps

ModelsExpand Collapse

AppGetResponse { data, paging, success }

data?: Array<Data>

id?: string

formatuuid

created_at?: string

formatdate-time

name?: string

paging?: Paging { end_offset, start_offset, total_count }

end_offset?: number

start_offset?: number

total_count?: number

success?: boolean

AppGetAppByIDResponse { data, success }

data?: Data { id, created_at, name }

id?: string

formatuuid

created_at?: string

formatdate-time

name?: string | null

success?: boolean

AppUpdateAppByIDResponse { data, success }

data: Data { id, cf_account_tag, created_at, 2 more }

id?: string

formatuuid

cf_account_tag?: string | null

created_at?: string

formatdate-time

is_org_on_kv?: boolean

name?: string | null

success: true

AppPostResponse { data, success }

data?: Data { app }

app?: App { id, created_at, name }

id?: string

formatuuid

created_at?: string

formatdate-time

name?: string

success?: boolean