Insights

Execute Sql

post

Execute a read-only SQL query against Databricks.

Authorizations

BearerAuth

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

application/json

sqlstring · min: 1 · max: 50000Required

Read-only SQL query against Databricks.

Responses

200

Successful Response

application/json

resultsany ofOptional

or

nullOptional

countany ofOptional

integerOptional

or

nullOptional

errorany ofOptional

stringOptional

or

nullOptional

422

Validation Error

application/json

post

/v1/{workspace_id}/insights/sql

HTTPcURLJavaScriptPython

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"
}

Describe Schema

get

List available tables, columns, and functions.

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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 Suggestions

get

Get contextual starter questions for the insights agent.

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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"
  ]
}

Get Digest

get

Proactive workspace health digest. Cached 5 minutes.

Authorizations

BearerAuth

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

HTTPcURLJavaScriptPython

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"
}

Create Session

post

Create a new insights chat session.

Authorizations

BearerAuth

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_atany ofOptional

stringOptional

or

nullOptional

post

/v1/{workspace_id}/insights/sessions

HTTPcURLJavaScriptPython

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"
}

Chat

post

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

Authorizations

BearerAuth

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

application/json

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

HTTPcURLJavaScriptPython

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

Get Session

get

Get insights session history.

Authorizations

BearerAuth

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}

HTTPcURLJavaScriptPython

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"
}