Spaces

Update a space

Changed on

Update a space's settings by its ID. At least one field must be provided.

Payload Requirements

  • At least one of name, description, is_private, default_llm_integration, ml_models_enabled, gradient_start_color, gradient_end_color, or default_agent_runtime must be provided.
  • Omitted fields keep their current value. description, default_llm_integration, and default_agent_runtime can be set to null to clear them.
  • If name is provided, it must be unique within the organization.
  • System-managed fields (id, created_at) cannot be modified.

<Note>This endpoint is in beta, read more here.</Note>

patch/v2/spaces/{space_id}

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/spaces/{space_id}
  • Auth
    HTTP bearer

Path parameters

space_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique space identifier (base64)

Request body

namestring

Updated name of the space

descriptionstring nullable

Updated description of the space. Set to null to clear it. An empty string is rejected.

is_privateboolean

Updated visibility for the space. Set to true to make the space private (visible only to members and admins), or false to make it public. When omitted, the existing visibility is preserved.

ml_models_enabledboolean

Whether machine learning models are enabled for the space.

gradient_start_colorstring

The starting color of the space's visual gradient.

gradient_end_colorstring

The ending color of the space's visual gradient.

Example request

{
  "default_llm_integration": {
    "integration_id": "RW50aXR5OjEyMzQ1"
  },
  "default_agent_runtime": {
    "integration_id": "RW50aXR5OjEyMzQ1"
  }
}

Response

A space object

idstring required

Unique identifier for the space

organization_idstring

A universally unique identifier (base64-encoded opaque string).

namestring required

Name of the space

descriptionstring required

A brief description of the space's purpose

created_atstring date-time required

Timestamp for when the space was created

is_privateboolean required

Whether the space is private. Private spaces are only visible to their members and account/org/space admins.

ml_models_enabledboolean

Whether machine learning models are enabled for the space.

gradient_start_colorstring

The first color in the gradient used for the space's avatar.

gradient_end_colorstring

The second color in the gradient used for the space's avatar.

Example response

{
  "organization_id": "RW50aXR5OjEyMzQ1",
  "default_llm_integration": {
    "integration_id": "RW50aXR5OjEyMzQ1"
  },
  "default_agent_runtime": {
    "integration_id": "RW50aXR5OjEyMzQ1"
  }
}

Changes

  • 622ee34f98ecRevision changes
    • 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

  • 84ac8681f9e2Revision changes
    • info

      added the optional property to the response with the status