SDK reference · Resources
client.users
client.users.{ create, get, list, assignComputer, deleteComputer }Register each person who uses your product once, with your own ID as external_id. Jobs, computers and connected accounts all belong to a user.
create
create(input: UserInput): Promise<Resource>Creates a user, or returns the existing one with this external_id, so it is safe to call on every sign-in.
Parameters
input.external_idstring- Your stable ID for the person, up to 200 characters.
input.computer_image"linux" | "android-14" | …optional- The computer this user gets when one is assigned (default linux).
Returns Promise<Resource>
Example · TypeScript
const user = await client.users.create({ external_id: "customer_123" });get
get(id: string): Promise<Resource>A user and their computer, if one is assigned.
Parameters
idstring- The user's ID (usr_…).
Returns Promise<Resource>
list
list(options?: ListOptions): Promise<Page>The application's users, oldest first.
Parameters
options{ after?: number; limit?: number }optional- Pagination: pass the previous page's next_cursor as after; limit is 1–200 (default 100).
Returns Promise<Page>
assignComputer
assignComputer(id: string): Promise<Resource>Starts the user's persistent computer, which computer jobs run on. Assigned once; it keeps the user's files between jobs.
Parameters
idstring- The user's ID.
Returns Promise<Resource>
deleteComputer
deleteComputer(id: string): Promise<Resource>Deletes the user's computer and its files.
Parameters
idstring- The user's ID.
Returns Promise<Resource>