Skip to main content

Update Workspace

PUT 

https://cloud.agenta.ai/api/organizations/:org_id/workspaces/:workspace_id

Update Workspace

Request

Path Parameters

    org_id Org Idrequired
    workspace_id Workspace Idrequired

Body

required

    name Name (string)
    description Description (string)
    updated_at date-time

Responses

Successful Response

Schema

    created_at date-time

    Default value: 2024-05-15T13:56:52.061787

    updated_at date-time

    Default value: 2024-05-15T13:56:52.061801

    id Id (string)required
    name Name (string)required
    description Description (string)
    type Type (string)
    organization Organization (string)required

    members

    object[]

  • Array [

  • user objectrequired

    roles

    object[]

    required

  • Array [

  • role_name WorkspaceRole (string)required

    Possible values: [owner, viewer, editor, evaluator, workspace_admin, deployment_manager]

    An enumeration.

    role_description Role Description (string)
    permissions Permission (string)[]

    Possible values: [read_system, view_application, edit_application, create_application, delete_application, create_app_variant, delete_app_variant, modify_variant_configurations, delete_application_variant, view_app_environment_deployment, edit_app_environment_deployment, create_app_environment_deployment, view_testset, edit_testset, create_testset, delete_testset, view_evaluation, run_evaluations, edit_evaluation, create_evaluation, delete_evaluation, deploy_application, view_workspace, edit_workspace, create_workspace, delete_workspace, modify_user_roles, add_new_user_to_workspace, edit_organization, delete_organization, add_new_user_to_organization]

  • ]

  • ]

curl -L -X PUT 'https://cloud.agenta.ai/api/organizations/:org_id/workspaces/:workspace_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
-d '{
"name": "string",
"description": "string",
"updated_at": "2024-08-19T07:55:03.475Z"
}'
Request Collapse all
Base URL
https://cloud.agenta.ai/api
Auth
Parameters
— pathrequired
— pathrequired
Body required
{
  "name": "string",
  "description": "string",
  "updated_at": "2024-08-19T07:55:03.475Z"
}
ResponseClear

Click the Send API Request button above and see the response here!