playground-settings

Update Playground Settings

Changed on

Update playground settings.

patch/api/v1/playground-settings/{playground_settings_id}

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/playground-settings/{playground_settings_id}
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or API key in header X-Organization-Id
    • or HTTP bearer

Path parameters

playground_settings_idstring uuid required

Request body

namestring nullable
descriptionstring nullable
settingsobject nullable
available_in_playgroundboolean nullable
available_in_evaluatorsboolean nullable
available_in_agent_builderboolean nullable
available_in_pollyboolean nullable
available_in_insights_heavyboolean nullable
available_in_insights_lightboolean nullable
oauth_enabledboolean nullable
oauth_token_urlstring nullable
oauth_client_idstring nullable
oauth_client_secretstring nullable
oauth_token_endpoint_auth_method'client_secret_basic' | 'client_secret_post' nullable
oauth_paramsobject nullable
oauth_headersobject nullable

Response

Successful Response

idstring uuid required
settingsobject required
namestring nullable
organization_idstring uuid nullable
created_atstring date-time required
updated_atstring date-time required
descriptionstring nullable
settings_type'complex' | 'simple'
created_by_ls_user_idstring uuid nullable
updated_by_ls_user_idstring uuid nullable
available_in_playgroundboolean
available_in_evaluatorsboolean
available_in_agent_builderboolean
available_in_pollyboolean
available_in_insights_heavyboolean
available_in_insights_lightboolean
oauth_enabledboolean nullable
oauth_token_urlstring nullable
oauth_client_idstring nullable
oauth_client_secretstring nullable
oauth_token_endpoint_auth_method'client_secret_basic' | 'client_secret_post' nullable
oauth_paramsobject nullable
oauth_headersobject nullable

Changes

  • 1a8ee9358d81Revision changes
    • breaking

      for the path request parameter playground_settings_id, the format changed from no format to uuid

    • breaking

      the / response's property type changed from object to string for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      the endpoint scheme security Organization ID was added to the API

    • info

      added the optional property to the response with the status

  • a0acb3a6a101Revision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status