Skip to content

Class: OpenCloud

Defined in: src/index.ts:35

Main entry point for the Roblox Open Cloud SDK. Provides access to all Roblox Open Cloud API resources.

Example

typescript
const client = new OpenCloud({
  apiKey: 'your-api-key-here'
});

const user = await client.users.get('123456789');
console.log(user.displayName);

Constructors

Constructor

ts
new OpenCloud(config): OpenCloud;

Defined in: src/index.ts:45

Creates a new OpenCloud SDK client instance.

Parameters

ParameterTypeDescription
configOpenCloudConfigConfiguration options for the client

Returns

OpenCloud

Properties

users

ts
users: Users;

Defined in: src/index.ts:37

Access to Users API endpoints


groups

ts
groups: Groups;

Defined in: src/index.ts:38