Profiles

Create Profile

Creates a new profile.

Method: client.profiles.create(): Promise<CreateProfileResponse>

Endpoint: POST /api/profile

Response: CreateProfileResponse

Example:

const profile = await client.profiles.create();
console.log(session.id);

Get Profile

Get details of an existing profile.

Method: client.profiles.get(id: string): Promise<ProfileResponse>

Endpoint: GET /api/profile/{id}

Parameters:

  • id: string - Profile ID

Response: ProfileResponse

Example:

const profile = await client.profiles.get("36946080-9b81-4288-81d5-b15f2191f222");
console.log(profile.id);

Delete Profile

Delete an existing profile.

Method: client.profiles.delete(id: string): Promise<BasicResponse>

Endpoint: DELETE /api/profile/{id}

Parameters:

  • id: string - Profile ID

Response: BasicResponse

Example:

const response = await client.profiles.delete("36946080-9b81-4288-81d5-b15f2191f222");
console.log(response);

Types

CreateProfileResponse

interface CreateProfileResponse {
  id: string;
}

ProfileResponse

interface ProfileResponse {
  id: string;
  teamId: string;
  createdAt: string;
  updatedAt: string;
}

Last updated

Logo

© 2025 S2 Labs, Inc. All rights reserved.