Skip to main content
PATCH
/
api
/
v1
/
playground-settings
/
{playground_settings_id}
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "settings": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "options": {
    "requests_per_second": 123
  },
  "name": "<string>",
  "description": "<string>",
  "settings_type": "complex",
  "created_by_ls_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_by_ls_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "available_in_playground": true,
  "available_in_evaluators": true,
  "available_in_agent_builder": false,
  "available_in_polly": false,
  "available_in_insights_heavy": false,
  "available_in_insights_light": false,
  "oauth_enabled": true,
  "oauth_token_url": "<string>",
  "oauth_client_id": "<string>",
  "oauth_client_secret": "<string>",
  "oauth_params": {},
  "oauth_headers": {}
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
playground_settings_id
string
required

Body

application/json
​
name
string | null
​
description
string | null
​
settings
Settings · object
​
options
PlaygroundSavedOptions · object
​
available_in_playground
boolean | null
​
available_in_evaluators
boolean | null
​
available_in_agent_builder
boolean | null
​
available_in_polly
boolean | null
​
available_in_insights_heavy
boolean | null
​
available_in_insights_light
boolean | null
​
oauth_enabled
boolean | null
​
oauth_token_url
string | null
​
oauth_client_id
string | null
​
oauth_client_secret
string | null
​
oauth_token_endpoint_auth_method
enum<string> | null
Available options:
client_secret_basic,
client_secret_post
​
oauth_params
Oauth Params · object
​
oauth_headers
Oauth Headers · object

Response

Successful Response

​
id
string<uuid>
required
​
settings
Settings · object
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
options
PlaygroundSavedOptions · object
​
name
string | null
​
description
string | null
​
settings_type
enum<string>
default:complex
Available options:
complex,
simple
​
created_by_ls_user_id
string<uuid> | null
​
updated_by_ls_user_id
string<uuid> | null
​
available_in_playground
boolean
default:true
​
available_in_evaluators
boolean
default:true
​
available_in_agent_builder
boolean
default:false
​
available_in_polly
boolean
default:false
​
available_in_insights_heavy
boolean
default:false
​
available_in_insights_light
boolean
default:false
​
oauth_enabled
boolean | null
​
oauth_token_url
string | null
​
oauth_client_id
string | null
​
oauth_client_secret
string | null
​
oauth_token_endpoint_auth_method
enum<string> | null
Available options:
client_secret_basic,
client_secret_post
​
oauth_params
Oauth Params · object
​
oauth_headers
Oauth Headers · object