Skip to main content
Playgrounds are running instances of an Environment. When you create a playground, Verial provisions live Sandboxes for each simulator in the environment, complete with credentials and loaded data.
Endpoints not yet in OpenAPI spec.

Endpoints

MethodEndpointDescription
GET/playgroundsList playgrounds
POST/playgroundsCreate a playground
GET/playgrounds/{id}Get playground details
POST/playgrounds/{id}/teardownTear down a playground

Playground Object

FieldTypeDescription
idstringUnique identifier
environment_idstringSource Environment
statusstringCurrent status (provisioning, active, teardown, etc.)
organization_idstringParent organization
created_atdatetimeCreation timestamp
updated_atdatetimeLast modification timestamp

SDK Example

// Create a playground from an environment
const playground = await verial.playgrounds.create({
  environmentId: 'env_abc123',
})

// List all playgrounds
const playgrounds = await verial.playgrounds.list()

// Get playground details (includes sandbox credentials)
const details = await verial.playgrounds.get({ id: playground.id })

// Tear down when done
await verial.playgrounds.teardown({ id: playground.id })