## Create

**post** `/v2/gen-ai/workspaces`

To create a new workspace, send a POST request to `/v2/gen-ai/workspaces`. The response body contains a JSON object with the newly created workspace object.

### Returns

- `workspace: optional APIWorkspace`

  - `agents: optional array of APIAgent`

    Agents

  - `created_at: optional string`

    Creation date

  - `created_by: optional string`

    The id of user who created this workspace

  - `created_by_email: optional string`

    The email of the user who created this workspace

  - `deleted_at: optional string`

    Deleted date

  - `description: optional string`

    Description of the workspace

  - `evaluation_test_cases: optional array of APIEvaluationTestCase`

    Evaluations

    - `archived_at: optional string`

    - `created_at: optional string`

    - `created_by_user_email: optional string`

    - `created_by_user_id: optional string`

    - `dataset: optional object { created_at, dataset_name, dataset_uuid, 3 more }`

      - `created_at: optional string`

        Time created at.

      - `dataset_name: optional string`

        Name of the dataset.

      - `dataset_uuid: optional string`

        UUID of the dataset.

      - `file_size: optional string`

        The size of the dataset uploaded file in bytes.

      - `has_ground_truth: optional boolean`

        Does the dataset have a ground truth column?

      - `row_count: optional number`

        Number of rows in the dataset.

    - `dataset_name: optional string`

    - `dataset_uuid: optional string`

    - `description: optional string`

    - `latest_version_number_of_runs: optional number`

    - `metrics: optional array of APIEvaluationMetric`

      - `description: optional string`

      - `inverted: optional boolean`

        If true, the metric is inverted, meaning that a lower value is better.

      - `metric_name: optional string`

      - `metric_type: optional "METRIC_TYPE_UNSPECIFIED" or "METRIC_TYPE_GENERAL_QUALITY" or "METRIC_TYPE_RAG_AND_TOOL"`

        - `"METRIC_TYPE_UNSPECIFIED"`

        - `"METRIC_TYPE_GENERAL_QUALITY"`

        - `"METRIC_TYPE_RAG_AND_TOOL"`

      - `metric_uuid: optional string`

      - `metric_value_type: optional "METRIC_VALUE_TYPE_UNSPECIFIED" or "METRIC_VALUE_TYPE_NUMBER" or "METRIC_VALUE_TYPE_STRING" or "METRIC_VALUE_TYPE_PERCENTAGE"`

        - `"METRIC_VALUE_TYPE_UNSPECIFIED"`

        - `"METRIC_VALUE_TYPE_NUMBER"`

        - `"METRIC_VALUE_TYPE_STRING"`

        - `"METRIC_VALUE_TYPE_PERCENTAGE"`

      - `range_max: optional number`

        The maximum value for the metric.

      - `range_min: optional number`

        The minimum value for the metric.

    - `name: optional string`

    - `star_metric: optional APIStarMetric`

      - `metric_uuid: optional string`

      - `name: optional string`

      - `success_threshold: optional number`

        The success threshold for the star metric.
        This is a value that the metric must reach to be considered successful.

      - `success_threshold_pct: optional number`

        The success threshold for the star metric.
        This is a percentage value between 0 and 100.

    - `test_case_uuid: optional string`

    - `total_runs: optional number`

    - `updated_at: optional string`

    - `updated_by_user_email: optional string`

    - `updated_by_user_id: optional string`

    - `version: optional number`

  - `name: optional string`

    Name of the workspace

  - `updated_at: optional string`

    Update date

  - `uuid: optional string`

    Unique id