Skip to main content
PUT
/
v1
/
environments
/
{environmentId}
/
playground
Update playground configuration
curl --request PUT \
  --url https://api.alpic.ai/v1/environments/{environmentId}/playground \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isPlaygroundEnabled": true,
  "name": "<string>",
  "description": "<string>",
  "headers": [
    {
      "name": "<string>",
      "description": "<string>",
      "isRequired": false,
      "isSecret": false
    }
  ],
  "examplePrompts": [
    {
      "title": "<string>",
      "prompt": "<string>"
    }
  ]
}
'
{
  "isPlaygroundEnabled": true,
  "serverMetadata": {
    "name": "<string>",
    "description": "<string>",
    "headers": [
      {
        "name": "<string>",
        "description": "<string>",
        "isRequired": true,
        "isSecret": true
      }
    ],
    "examplePrompts": [
      {
        "title": "<string>",
        "prompt": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.

Path Parameters

environmentId
string
required

The ID of the environment

Body

application/json
isPlaygroundEnabled
boolean
name
string
Required string length: 1 - 100
description
string
Required string length: 1 - 500
headers
object[]
examplePrompts
object[]
Maximum array length: 3

Response

The updated playground configuration

isPlaygroundEnabled
boolean
required
serverMetadata
object
required