Class PlatformClient

Index

Constructors

Accessors

Methods

setAccessToken setRefreshToken extend forApp withCredentials withSecretKey withToken

Constructors

constructor

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

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`event_subscription_deliveries

event_subscription_deliveries: EventSubscriptionDeliveryResource

`Readonly`event_subscriptions

event_subscriptions: EventSubscriptionResource

`Readonly`external_object_capabilities

external_object_capabilities: ExternalObjectCapabilityResource

`Readonly`external_objects

external_objects: ExternalObjectResource

`Readonly`extractions

extractions: ExtractionResource

`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_ingestions

knowledge_ingestions: KnowledgeIngestionResource

`Readonly`knowledge_sources

knowledge_sources: KnowledgeSourceResource

`Readonly`kv

`Readonly`notification_preferences

notification_preferences: NotificationPreferenceResource

`Readonly`notifications

notifications: NotificationResource

`Readonly`oauth

oauth: OauthResource

`Readonly`orgs

orgs: OrgResource

`Readonly`private_service_definitions

private_service_definitions: PrivateServiceDefinitionResource

`Readonly`private_service_enrollments

private_service_enrollments: PrivateServiceEnrollmentResource

`Readonly`private_services

private_services: PrivateServiceResource

`Readonly`sandboxes

sandboxes: SandboxResource

`Readonly`scripts

scripts: ScriptResource

`Readonly`slack_channel_bindings

slack_channel_bindings: SlackChannelBindingResource

`Readonly`solution_categories

solution_categories: SolutionCategoryResource

`Readonly`solution_instances

solution_instances: SolutionInstanceResource

`Readonly`solution_tags

solution_tags: SolutionTagResource

`Readonly`solutions

solutions: SolutionResource

`Readonly`ssh_keys

ssh_keys: SshKeyResource

`Readonly`status

status: StatuResource

`Readonly`tasks

tasks: TaskResource

`Readonly`team_memberships

team_memberships: TeamMembershipResource

`Readonly`teams

teams: TeamResource

`Readonly`thread_messages

thread_messages: ThreadMessageResource

`Readonly`threads

threads: ThreadResource

`Readonly`trajectories

trajectories: TrajectoryResource

`Readonly`users

users: UserResource

`Readonly`v1

v1: V1

`Readonly`work_items

work_items: WorkItemResource

`Readonly`workflows

workflows: WorkflowResource

Accessors

refreshToken

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

Methods

setAccessToken

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

setRefreshToken

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

`Static`extend

extend<
    TBase extends PlatformClientConstructor<PlatformClient>,
    TExtended extends PlatformClientConstructor<PlatformClient>,
>(
    this: TBase,
    extension: PlatformClientExtension<TBase, TExtended>,
): PlatformClientClass<InstanceType<TExtended>>
Return a subclass augmented by a hand-maintained class-expression mixin.
Type Parameters
- TBase extends PlatformClientConstructor<PlatformClient>
- TExtended extends PlatformClientConstructor<PlatformClient>
Parameters
- this: TBase
- extension: PlatformClientExtension<TBase, TExtended>
Returns PlatformClientClass<InstanceType<TExtended>>
- Defined in packages/sdk/src/client.ts:228

`Static`forApp

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

`Static`withCredentials

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

`Static`withSecretKey

withSecretKey<TClient extends PlatformClient>(
    this: PlatformClientConstructor<TClient>,
    key: string,
    baseUrl?: string,
): TClient
Secret API key — full admin access, no user JWT required
Type Parameters
- TClient extends PlatformClient
Parameters
- this: PlatformClientConstructor<TClient>
- key: string
- OptionalbaseUrl: string
Returns TClient
- Defined in packages/sdk/src/client.ts:253

`Static`withToken

withToken<TClient extends PlatformClient>(
    this: PlatformClientConstructor<TClient>,
    apiKey: string,
    accessToken: string,
    baseUrl?: string,
): TClient
Create a client with a publishable key and pre-existing access token.
Type Parameters
- TClient extends PlatformClient
Parameters
- this: PlatformClientConstructor<TClient>
- apiKey: string
- accessToken: string
- OptionalbaseUrl: string
Returns TClient
- Defined in packages/sdk/src/client.ts:261