Insights

Query workspace data, explore schema metadata, and get health digests through the platform insights endpoints.

Insights supports interactive, read-only exploration of workspace data. It sits alongside Workspace Data Queries, which are registered agent tools, and the MCP Server, which exposes SQL tools to external MCP clients.

Insights operations require viewer+ (Data:View) except raw SQL execution, which requires Data:Query at the admin tier or above.

Execute SQL

Runs a read-only statement against the workspace-scoped analytics surface.

Execute Sql

post

Execute a read-only SQL query against Databricks.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

sqlstring · min: 1 · max: 50000Required

Read-only SQL query against Databricks.

Responses

200

Successful Response

application/json

countinteger · nullableOptional

errorstring · nullableOptional

422

Validation Error

application/json

post/v1/{workspace_id}/insights/sql

POST /v1/{workspace_id}/insights/sql HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "sql": "text"
}

{
  "results": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "count": 1,
  "error": "text"
}

List Query Schema

Describe Schema

get

List available tables, columns, and functions.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

databricks_catalogsstring[]Required

ai_functionsstring[]Required

get/v1/{workspace_id}/insights/schema

GET /v1/{workspace_id}/insights/schema HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

{
  "lakebase_tables": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "databricks_catalogs": [
    "text"
  ],
  "uc_functions": [
    {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  ],
  "ai_functions": [
    "text"
  ]
}

Get Health Digest

Returns a workspace health snapshot. Analytical values can lag recent workspace changes.

Get Digest

get

Proactive workspace health digest. Cached 5 minutes.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

Other propertiesanyOptional

get/v1/{workspace_id}/insights/digest

GET /v1/{workspace_id}/insights/digest HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get Suggestions

Get Suggestions

get

Get contextual starter questions for the insights agent.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

suggestionsstring[]Required

get/v1/{workspace_id}/insights/suggestions

GET /v1/{workspace_id}/insights/suggestions HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

{
  "suggestions": [
    "text"
  ]
}

Chat Sessions

Create a Session

Create Session

post

Create a new insights chat session.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstringRequired

created_atstring · nullableOptional

post/v1/{workspace_id}/insights/sessions

POST /v1/{workspace_id}/insights/sessions HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

{
  "id": "text",
  "created_at": "text"
}

Get a Session

An unknown or expired session returns an empty message history with an error field rather than 404.

Get Session

get

Get insights session history.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

session_idstring · max: 64Required

Session ID

Responses

200

Successful Response

application/json

Other propertiesanyOptional

422

Validation Error

application/json

get/v1/{workspace_id}/insights/sessions/{session_id}

GET /v1/{workspace_id}/insights/sessions/{session_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Chat

Chat returns a Server-Sent Events stream of response blocks.

Chat

post

Chat with the insights agent. Returns SSE stream of visual blocks.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

session_idstring · max: 64Required

Session ID

Body

messagestring · min: 1 · max: 16000Required

Insights chat user message.

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

post/v1/{workspace_id}/insights/sessions/{session_id}/chat

POST /v1/{workspace_id}/insights/sessions/{session_id}/chat HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "message": "text"
}

No content