Space

View as Markdown

GenieSpace object

space_idstring: Genie space ID
Example: e1ef34712a29169db030324fd0e1df5f

titlestring: Title of the Genie Space

descriptionstring: Description of the Genie Space

warehouse_idstring: Warehouse associated with the Genie Space

parent_pathstring: Parent folder path of the Genie Space

serialized_spacestring: The contents of the Genie Space in serialized string form. This field is excluded in List Genie spaces responses. Use the Get Genie Space API to retrieve an example response, which includes the serialized_space field. This field provides the structure of the JSON string that represents the space's layout and components.

etagstring: ETag for this space. Pass this value back in the update request to prevent overwriting concurrent changes.

create_timestring: Time when the Genie space was created.

update_timestring: Time when the Genie space was last modified, matching the value shown in the Genie Agent UI.

View as Markdown

The GenieSpace object

{
  "space_id": "e1ef34712a29169db030324fd0e1df5f",
  "title": "string",
  "description": "string",
  "warehouse_id": "string",
  "parent_path": "string",
  "serialized_space": "{  \"version\": 2,  \"config\": {    \"sample_questions\": [      { \"id\": \"a1b2c3d4e5f60000000000000000000a\", \"question\": [\"What were total sales last month?\"] },      { \"id\": \"b2c3d4e5f6a70000000000000000000b\", \"question\": [\"Show top 10 customers by revenue\"] }    ]  },  \"data_sources\": {    \"tables\": [      { \"identifier\": \"sales.analytics.customers\", \"description\": [\"Customer master data\"] },      { \"identifier\": \"sales.analytics.orders\", \"description\": [\"Order transactions\"] },      { \"identifier\": \"sales.analytics.products\" }    ],    \"metric_views\": [      { \"identifier\": \"sales.analytics.revenue_metrics\", \"description\": [\"Revenue metrics\"] }    ]  },  \"instructions\": {    \"text_instructions\": [      { \"id\": \"01f0b37c378e1c9100000000000000a1\", \"content\": [\"General instructions for the space.\"] }    ],    \"example_question_sqls\": [      { \"id\": \"01f0821116d912db00000000000000b1\", \"question\": [\"Show top 10 customers\"], \"sql\": [\"SELECT ...\"] }    ],    \"sql_functions\": [      { \"id\": \"01f0c0b4e815100000000000000000f1\", \"identifier\": \"sales.analytics.fiscal_quarter\" }    ],    \"join_specs\": [      { \"id\": \"01f0c0b4e815100000000000000000c1\", \"left\": { \"identifier\": \"sales.analytics.orders\" }, \"right\": { \"identifier\": \"sales.analytics.customers\" }, \"sql\": [\"orders.customer_id = customers.customer_id\"] }    ],    \"sql_snippets\": {      \"filters\": [{ \"id\": \"01f09972e66d100000000000000000d1\", \"sql\": [\"amount \u003e 1000\"], \"display_name\": \"high value\" }],      \"expressions\": [{ \"id\": \"01f09974563a100000000000000000e1\", \"alias\": \"order_year\", \"sql\": [\"YEAR(order_date)\"] }],      \"measures\": [{ \"id\": \"01f09972611f100000000000000000f1\", \"alias\": \"total_revenue\", \"sql\": [\"SUM(amount)\"] }]    }  },  \"benchmarks\": {    \"questions\": [      { \"id\": \"01f0d0b4e815100000000000000000g1\", \"question\": [\"What is average order value?\"], \"answer\": [{ \"format\": \"SQL\", \"content\": [\"SELECT AVG(amount)...\"] }] }    ]  }}",
  "etag": "string",
  "create_time": "string",
  "update_time": "string"
}

Get

GET /api/2.0/genie/spaces/{space_id}

Get details of a Genie Space.

API scopes: genie

Parameters

space_idstringpath: The ID associated with the Genie space
Example: e1ef34712a29169db030324fd0e1df5f

include_serialized_spacebooleanquery: Whether to include the serialized space export in the response. Requires at least CAN EDIT permission on the space.
Default: false

Response

Returns the GenieSpace object.

View as Markdown

Response

{
  "space_id": "e1ef34712a29169db030324fd0e1df5f",
  "title": "string",
  "description": "string",
  "warehouse_id": "string",
  "parent_path": "string",
  "serialized_space": "{  \"version\": 2,  \"config\": {    \"sample_questions\": [      { \"id\": \"a1b2c3d4e5f60000000000000000000a\", \"question\": [\"What were total sales last month?\"] },      { \"id\": \"b2c3d4e5f6a70000000000000000000b\", \"question\": [\"Show top 10 customers by revenue\"] }    ]  },  \"data_sources\": {    \"tables\": [      { \"identifier\": \"sales.analytics.customers\", \"description\": [\"Customer master data\"] },      { \"identifier\": \"sales.analytics.orders\", \"description\": [\"Order transactions\"] },      { \"identifier\": \"sales.analytics.products\" }    ],    \"metric_views\": [      { \"identifier\": \"sales.analytics.revenue_metrics\", \"description\": [\"Revenue metrics\"] }    ]  },  \"instructions\": {    \"text_instructions\": [      { \"id\": \"01f0b37c378e1c9100000000000000a1\", \"content\": [\"General instructions for the space.\"] }    ],    \"example_question_sqls\": [      { \"id\": \"01f0821116d912db00000000000000b1\", \"question\": [\"Show top 10 customers\"], \"sql\": [\"SELECT ...\"] }    ],    \"sql_functions\": [      { \"id\": \"01f0c0b4e815100000000000000000f1\", \"identifier\": \"sales.analytics.fiscal_quarter\" }    ],    \"join_specs\": [      { \"id\": \"01f0c0b4e815100000000000000000c1\", \"left\": { \"identifier\": \"sales.analytics.orders\" }, \"right\": { \"identifier\": \"sales.analytics.customers\" }, \"sql\": [\"orders.customer_id = customers.customer_id\"] }    ],    \"sql_snippets\": {      \"filters\": [{ \"id\": \"01f09972e66d100000000000000000d1\", \"sql\": [\"amount \u003e 1000\"], \"display_name\": \"high value\" }],      \"expressions\": [{ \"id\": \"01f09974563a100000000000000000e1\", \"alias\": \"order_year\", \"sql\": [\"YEAR(order_date)\"] }],      \"measures\": [{ \"id\": \"01f09972611f100000000000000000f1\", \"alias\": \"total_revenue\", \"sql\": [\"SUM(amount)\"] }]    }  },  \"benchmarks\": {    \"questions\": [      { \"id\": \"01f0d0b4e815100000000000000000g1\", \"question\": [\"What is average order value?\"], \"answer\": [{ \"format\": \"SQL\", \"content\": [\"SELECT AVG(amount)...\"] }] }    ]  }}",
  "etag": "string",
  "create_time": "string",
  "update_time": "string"
}

List

GET /api/2.0/genie/spaces

Get list of Genie Spaces.

API scopes: genie

Parameters

page_sizeint32query: Maximum number of spaces to return per page
Default: 20
Constraints: <= 100

page_tokenstringquery: Pagination token for getting the next page of results

Response

Returns a list of GenieSpace objects.

View as Markdown

Response

{
  "spaces": [
    {
      "space_id": "e1ef34712a29169db030324fd0e1df5f",
      "title": "string",
      "description": "string",
      "warehouse_id": "string",
      "parent_path": "string",
      "serialized_space": "{  \"version\": 2,  \"config\": {    \"sample_questions\": [      { \"id\": \"a1b2c3d4e5f60000000000000000000a\", \"question\": [\"What were total sales last month?\"] },      { \"id\": \"b2c3d4e5f6a70000000000000000000b\", \"question\": [\"Show top 10 customers by revenue\"] }    ]  },  \"data_sources\": {    \"tables\": [      { \"identifier\": \"sales.analytics.customers\", \"description\": [\"Customer master data\"] },      { \"identifier\": \"sales.analytics.orders\", \"description\": [\"Order transactions\"] },      { \"identifier\": \"sales.analytics.products\" }    ],    \"metric_views\": [      { \"identifier\": \"sales.analytics.revenue_metrics\", \"description\": [\"Revenue metrics\"] }    ]  },  \"instructions\": {    \"text_instructions\": [      { \"id\": \"01f0b37c378e1c9100000000000000a1\", \"content\": [\"General instructions for the space.\"] }    ],    \"example_question_sqls\": [      { \"id\": \"01f0821116d912db00000000000000b1\", \"question\": [\"Show top 10 customers\"], \"sql\": [\"SELECT ...\"] }    ],    \"sql_functions\": [      { \"id\": \"01f0c0b4e815100000000000000000f1\", \"identifier\": \"sales.analytics.fiscal_quarter\" }    ],    \"join_specs\": [      { \"id\": \"01f0c0b4e815100000000000000000c1\", \"left\": { \"identifier\": \"sales.analytics.orders\" }, \"right\": { \"identifier\": \"sales.analytics.customers\" }, \"sql\": [\"orders.customer_id = customers.customer_id\"] }    ],    \"sql_snippets\": {      \"filters\": [{ \"id\": \"01f09972e66d100000000000000000d1\", \"sql\": [\"amount \u003e 1000\"], \"display_name\": \"high value\" }],      \"expressions\": [{ \"id\": \"01f09974563a100000000000000000e1\", \"alias\": \"order_year\", \"sql\": [\"YEAR(order_date)\"] }],      \"measures\": [{ \"id\": \"01f09972611f100000000000000000f1\", \"alias\": \"total_revenue\", \"sql\": [\"SUM(amount)\"] }]    }  },  \"benchmarks\": {    \"questions\": [      { \"id\": \"01f0d0b4e815100000000000000000g1\", \"question\": [\"What is average order value?\"], \"answer\": [{ \"format\": \"SQL\", \"content\": [\"SELECT AVG(amount)...\"] }] }    ]  }}",
      "etag": "string",
      "create_time": "string",
      "update_time": "string"
    }
  ],
  "next_page_token": "string"
}

Create

POST /api/2.0/genie/spaces

Creates a Genie space from a serialized payload.

API scopes: genie

Request body

warehouse_idstring: Warehouse to associate with the new space

parent_pathstring: Parent folder path where the space will be registered

serialized_spacestring: The contents of the Genie Space in serialized string form. Use the Get Genie Space API to retrieve an example response, which includes the serialized_space field. This field provides the structure of the JSON string that represents the space's layout and components.

titlestring: Optional title override

descriptionstring: Optional description

Response

Returns the GenieSpace object.

View as Markdown

Request

{
  "warehouse_id": "string",
  "parent_path": "string",
  "serialized_space": "string",
  "title": "string",
  "description": "string"
}

Response

{
  "space_id": "e1ef34712a29169db030324fd0e1df5f",
  "title": "string",
  "description": "string",
  "warehouse_id": "string",
  "parent_path": "string",
  "serialized_space": "{  \"version\": 2,  \"config\": {    \"sample_questions\": [      { \"id\": \"a1b2c3d4e5f60000000000000000000a\", \"question\": [\"What were total sales last month?\"] },      { \"id\": \"b2c3d4e5f6a70000000000000000000b\", \"question\": [\"Show top 10 customers by revenue\"] }    ]  },  \"data_sources\": {    \"tables\": [      { \"identifier\": \"sales.analytics.customers\", \"description\": [\"Customer master data\"] },      { \"identifier\": \"sales.analytics.orders\", \"description\": [\"Order transactions\"] },      { \"identifier\": \"sales.analytics.products\" }    ],    \"metric_views\": [      { \"identifier\": \"sales.analytics.revenue_metrics\", \"description\": [\"Revenue metrics\"] }    ]  },  \"instructions\": {    \"text_instructions\": [      { \"id\": \"01f0b37c378e1c9100000000000000a1\", \"content\": [\"General instructions for the space.\"] }    ],    \"example_question_sqls\": [      { \"id\": \"01f0821116d912db00000000000000b1\", \"question\": [\"Show top 10 customers\"], \"sql\": [\"SELECT ...\"] }    ],    \"sql_functions\": [      { \"id\": \"01f0c0b4e815100000000000000000f1\", \"identifier\": \"sales.analytics.fiscal_quarter\" }    ],    \"join_specs\": [      { \"id\": \"01f0c0b4e815100000000000000000c1\", \"left\": { \"identifier\": \"sales.analytics.orders\" }, \"right\": { \"identifier\": \"sales.analytics.customers\" }, \"sql\": [\"orders.customer_id = customers.customer_id\"] }    ],    \"sql_snippets\": {      \"filters\": [{ \"id\": \"01f09972e66d100000000000000000d1\", \"sql\": [\"amount \u003e 1000\"], \"display_name\": \"high value\" }],      \"expressions\": [{ \"id\": \"01f09974563a100000000000000000e1\", \"alias\": \"order_year\", \"sql\": [\"YEAR(order_date)\"] }],      \"measures\": [{ \"id\": \"01f09972611f100000000000000000f1\", \"alias\": \"total_revenue\", \"sql\": [\"SUM(amount)\"] }]    }  },  \"benchmarks\": {    \"questions\": [      { \"id\": \"01f0d0b4e815100000000000000000g1\", \"question\": [\"What is average order value?\"], \"answer\": [{ \"format\": \"SQL\", \"content\": [\"SELECT AVG(amount)...\"] }] }    ]  }}",
  "etag": "string",
  "create_time": "string",
  "update_time": "string"
}

Update

PATCH /api/2.0/genie/spaces/{space_id}

Updates a Genie space with a serialized payload.

API scopes: genie

Parameters

space_idstringpath: Genie space ID

Request body

serialized_spacestring: The contents of the Genie Space in serialized string form (full replacement). Use the Get Genie Space API to retrieve an example response, which includes the serialized_space field. This field provides the structure of the JSON string that represents the space's layout and components.

titlestring: Optional title override

descriptionstring: Optional description

warehouse_idstring: Optional warehouse override

etagstring: ETag returned by a previous GET or UPDATE. When set, the update will fail if the space has been modified since. Omit to apply the update unconditionally.

parent_pathstring: Parent workspace folder path to move this Genie space under.

Response

Returns the GenieSpace object.

View as Markdown

Request

{
  "serialized_space": "string",
  "title": "string",
  "description": "string",
  "warehouse_id": "string",
  "etag": "string",
  "parent_path": "string"
}

Response

{
  "space_id": "e1ef34712a29169db030324fd0e1df5f",
  "title": "string",
  "description": "string",
  "warehouse_id": "string",
  "parent_path": "string",
  "serialized_space": "{  \"version\": 2,  \"config\": {    \"sample_questions\": [      { \"id\": \"a1b2c3d4e5f60000000000000000000a\", \"question\": [\"What were total sales last month?\"] },      { \"id\": \"b2c3d4e5f6a70000000000000000000b\", \"question\": [\"Show top 10 customers by revenue\"] }    ]  },  \"data_sources\": {    \"tables\": [      { \"identifier\": \"sales.analytics.customers\", \"description\": [\"Customer master data\"] },      { \"identifier\": \"sales.analytics.orders\", \"description\": [\"Order transactions\"] },      { \"identifier\": \"sales.analytics.products\" }    ],    \"metric_views\": [      { \"identifier\": \"sales.analytics.revenue_metrics\", \"description\": [\"Revenue metrics\"] }    ]  },  \"instructions\": {    \"text_instructions\": [      { \"id\": \"01f0b37c378e1c9100000000000000a1\", \"content\": [\"General instructions for the space.\"] }    ],    \"example_question_sqls\": [      { \"id\": \"01f0821116d912db00000000000000b1\", \"question\": [\"Show top 10 customers\"], \"sql\": [\"SELECT ...\"] }    ],    \"sql_functions\": [      { \"id\": \"01f0c0b4e815100000000000000000f1\", \"identifier\": \"sales.analytics.fiscal_quarter\" }    ],    \"join_specs\": [      { \"id\": \"01f0c0b4e815100000000000000000c1\", \"left\": { \"identifier\": \"sales.analytics.orders\" }, \"right\": { \"identifier\": \"sales.analytics.customers\" }, \"sql\": [\"orders.customer_id = customers.customer_id\"] }    ],    \"sql_snippets\": {      \"filters\": [{ \"id\": \"01f09972e66d100000000000000000d1\", \"sql\": [\"amount \u003e 1000\"], \"display_name\": \"high value\" }],      \"expressions\": [{ \"id\": \"01f09974563a100000000000000000e1\", \"alias\": \"order_year\", \"sql\": [\"YEAR(order_date)\"] }],      \"measures\": [{ \"id\": \"01f09972611f100000000000000000f1\", \"alias\": \"total_revenue\", \"sql\": [\"SUM(amount)\"] }]    }  },  \"benchmarks\": {    \"questions\": [      { \"id\": \"01f0d0b4e815100000000000000000g1\", \"question\": [\"What is average order value?\"], \"answer\": [{ \"format\": \"SQL\", \"content\": [\"SELECT AVG(amount)...\"] }] }    ]  }}",
  "etag": "string",
  "create_time": "string",
  "update_time": "string"
}

Delete

DELETE /api/2.0/genie/spaces/{space_id}

Move a Genie Space to the trash.

API scopes: genie

Parameters

space_idstringpath: The ID associated with the Genie space to be sent to the trash.
Example: e1ef34712a29169db030324fd0e1df5f

Download Message Attachment Visualization

GET /api/2.0/genie/{name=spaces/*/conversations/*/messages/*/attachments/*}/download-visualization

Download a rendered image of a message visualization attachment. The response body is the raw PNG image, not a JSON payload. This is only available if the attachment is a visualization and the message status is COMPLETED. This endpoint is not supported for Private Link workspaces.

API scopes: genie

Parameters

namestringpath: The resource name of the attachment to render, in the format spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}.

Response

contentsstring: The rendered visualization as a PNG image. Returned as the raw HTTP response body rather than a JSON field.

GenieSpace object​

Get​

Parameters​

Response​

List​

Parameters​

Response​

Create​

Request body​

Response​

Update​

Parameters​

Request body​

Response​

Delete​

Parameters​

Download Message Attachment Visualization​

Parameters​

Response​

GenieSpace object

Get

Parameters

Response

List

Parameters

Response

Create

Request body

Response

Update

Parameters

Request body

Response

Delete

Parameters

Download Message Attachment Visualization

Parameters

Response