Skip to main content
POST
/
environments
Create environment
curl --request POST \
  --url https://api.verial.ai/environments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.verial.ai/llms.txt

Use this file to discover all available pages before exploring further.

Create a new environment with its simulator configuration. Environments are reusable definitions that can be instantiated as playgrounds or referenced by benchmarks.

​
What’s Next

After creating an environment, you can:
  1. Create a benchmark that references this environment
  2. Create a playground to instantiate it for live testing

Authorizations

​
Authorization
string
header
required

API key passed as a Bearer token.

Body

application/json
​
name
string
required
Required string length: 1 - 200
​
description
string
Maximum string length: 1000

Response

Successful response

​
id
string<date-time>
required
​
name
string
required
​
description
string | null
required
​
created_at
string<date-time>
required