Spaces

Create a space

Changed on

Create a new space within an organization.

Payload Requirements

  • name and organization_id are required.
  • The space name must be unique within the organization.
  • description is optional and defaults to an empty string if omitted.
  • System-managed fields (id, created_at) are generated automatically and rejected if provided.

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

post/v2/spaces

Request

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

Request body

namestring required

Name of the space (must be unique within the organization)

organization_idstring required

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

descriptionstring

A brief description of the space's purpose. Defaults to an empty string if omitted.

is_privateboolean

Whether to create the space as private. Private spaces are only visible to their members and account/org/space admins. Defaults to false (public) if omitted.

Example request

{
  "organization_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 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