Class PlatformClient

Constructors

constructor

new PlatformClient(config?: PlatformClientConfig): PlatformClient
Parameters
- config: PlatformClientConfig = {}
Returns PlatformClient
- Defined in packages/sdk/src/client.ts:98

Properties

`Readonly`activity_feed

activity_feed: ActivityFeedResource

`Readonly`agent_computers

agent_computers: AgentComputerResource

`Readonly`agent_env_vars

agent_env_vars: AgentEnvVarResource

`Readonly`agent_health_actions

agent_health_actions: AgentHealthActionResource

`Readonly`agent_installations

agent_installations: AgentInstallationResource

`Readonly`agent_routine_runs

agent_routine_runs: AgentRoutineRunResource

`Readonly`agent_routines

agent_routines: AgentRoutineResource

`Readonly`agent_sessions

agent_sessions: AgentSessionResource

`Readonly`agent_skills

agent_skills: AgentSkillResource

`Readonly`agent_tools

agent_tools: AgentToolResource

`Readonly`agents

agents: AgentResource

`Readonly`ai

`Readonly`artifacts

artifacts: ArtifactResource

`Readonly`auth

auth: AuthClient

`Readonly`automation_runs

automation_runs: AutomationRunResource

`Readonly`automations

automations: AutomationResource

`Readonly`bug_reports

bug_reports: BugReportResource

`Readonly`config

config: ConfigResource

`Readonly`custom_objects

custom_objects: CustomObjectResource

`Readonly`files

files: FileResource

`Readonly`http

http: HttpClient

`Readonly`installation_sources

installation_sources: InstallationSourceResource

`Readonly`invites

invites: InviteResource

`Readonly`knowledge_documents

knowledge_documents: KnowledgeDocumentResource

`Readonly`knowledge_sources

knowledge_sources: KnowledgeSourceResource

`Readonly`kv

`Readonly`notification_preferences

notification_preferences: NotificationPreferenceResource

`Readonly`notifications

notifications: NotificationResource

`Readonly`orgs

orgs: OrgResource

`Readonly`slack_channel_bindings

slack_channel_bindings: SlackChannelBindingResource

`Readonly`solution_categories

solution_categories: SolutionCategoryResource

`Readonly`solution_tags

solution_tags: SolutionTagResource

`Readonly`solutions

solutions: SolutionResource

`Readonly`team_memberships

team_memberships: TeamMembershipResource

`Readonly`teams

teams: TeamResource

`Readonly`thread_messages

thread_messages: ThreadMessageResource

`Readonly`threads

threads: ThreadResource

`Readonly`users

users: UserResource

`Readonly`v1

v1: V1

Accessors

refreshToken

get refreshToken(): string | undefined
Returns string | undefined
- Defined in packages/sdk/src/client.ts:152

Methods

setAccessToken

setAccessToken(token: string): void
Parameters
- token: string
Returns void
- Defined in packages/sdk/src/client.ts:156

setRefreshToken

setRefreshToken(token: string): void
Parameters
- token: string
Returns void
- Defined in packages/sdk/src/client.ts:160

`Static`forApp

forApp(options: ForAppOptions): AppPlatformClient
Client-side app: publishable key + durable session storage. Wires passwordless OTP, restore/signIn/signOut, 401 auto-refresh, and createSocket().
Parameters
- options: ForAppOptions
Returns AppPlatformClient
- Defined in packages/sdk/src/client.ts:212

`Static`withCredentials

withCredentials(
    apiKey: string,
    email: string,
    password: string,
    baseUrl?: string,
): Promise<PlatformClient>
Create a client by logging in with email/password
Parameters
- apiKey: string
- email: string
- password: string
- OptionalbaseUrl: string
Returns Promise<PlatformClient>
- Defined in packages/sdk/src/client.ts:184

`Static`withSecretKey

withSecretKey(key: string, baseUrl?: string): PlatformClient
Secret API key — full admin access, no user JWT required
Parameters
- key: string
- OptionalbaseUrl: string
Returns PlatformClient
- Defined in packages/sdk/src/client.ts:167

`Static`withToken

withToken(apiKey: string, accessToken: string, baseUrl?: string): PlatformClient
Create a client with a publishable key and pre-existing access token.
Parameters
- apiKey: string
- accessToken: string
- OptionalbaseUrl: string
Returns PlatformClient
- Defined in packages/sdk/src/client.ts:175