Workspace Lakebase

Get fork status

get

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

or

nullOptional

429

Rate limited

get

/v1/{workspace_id}/fork

HTTPcURLJavaScriptPython

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

{
  "endpoint": "text",
  "ttl_days": 1,
  "status": "pending"
}

Create a Lakebase fork (sandbox)

post

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

ttl_daysinteger · min: 1 · max: 30OptionalDefault: 7

Responses

201

Successful Response

application/json

422

Validation error

429

Rate limited

post

/v1/{workspace_id}/fork

HTTPcURLJavaScriptPython

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

{
  "ttl_days": 7
}

{
  "endpoint": "text",
  "ttl_days": 1,
  "status": "pending"
}

Destroy fork

delete

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

204

Successful Response

422

Validation error

429

Rate limited

delete

/v1/{workspace_id}/fork

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/fork HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Execute SQL against workspace Lakebase

post

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

Responses

200

Successful Response

application/json

columnsany ofOptional

string[]Optional

or

nullOptional

rowsany ofOptional

or

nullOptional

row_countintegerRequired

422

Validation error

429

Rate limited

post

/v1/{workspace_id}/lakebase/query

HTTPcURLJavaScriptPython

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

{
  "sql": "text"
}

{
  "columns": [
    "text"
  ],
  "rows": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "row_count": 1
}

List query tools

get

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

Query parameters

limitinteger · max: 20OptionalDefault: 10

continuation_tokenintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenany ofOptional

integerOptional

or

nullOptional

totalany ofOptional

integerOptional

or

nullOptional

422

Validation Error

application/json

429

Rate limited

get

/v1/{workspace_id}/query-tools

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "id": "text",
      "workspace_id": "text",
      "name": "text",
      "description": "text",
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "query": "text",
      "target": "text",
      "enabled": true,
      "created_at": "text",
      "updated_at": "text"
    }
  ],
  "has_more": true,
  "continuation_token": 1,
  "total": 1
}

Create a query tool

post

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

namestring · min: 1 · max: 256Required

descriptionstring · max: 2000OptionalDefault: ""

querystring · min: 1 · max: 50000Required

targetconst: lakebaseOptionalDefault: lakebase

Responses

201

Successful Response

application/json

422

Validation error

429

Rate limited

post

/v1/{workspace_id}/query-tools

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "description": "",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "query": "text",
  "target": "lakebase"
}

{
  "id": "text",
  "workspace_id": "text",
  "name": "text",
  "description": "text",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "query": "text",
  "target": "text",
  "enabled": true,
  "created_at": "text",
  "updated_at": "text"
}

Delete a query tool

delete

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

tool_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

429

Rate limited

delete

/v1/{workspace_id}/query-tools/{tool_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/query-tools/{tool_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a query tool

patch

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

tool_idstring · uuidRequired

Body

application/json

nameany ofOptional

string · min: 1 · max: 256Optional

or

nullOptional

descriptionany ofOptional

string · max: 2000Optional

or

nullOptional

parametersany ofOptional

or

nullOptional

queryany ofOptional

string · min: 1 · max: 50000Optional

or

nullOptional

enabledany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

idstringRequired

workspace_idstringRequired

namestringRequired

descriptionstringRequired

querystringRequired

targetconst: lakebaseRequired

enabledbooleanRequired

created_atany ofOptional

stringOptional

or

nullOptional

updated_atany ofOptional

stringOptional

or

nullOptional

404

Tool not found

422

Validation error

429

Rate limited

patch

/v1/{workspace_id}/query-tools/{tool_id}

HTTPcURLJavaScriptPython

PATCH /v1/{workspace_id}/query-tools/{tool_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "name": "text",
  "description": "text",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "query": "text",
  "enabled": true
}

{
  "id": "text",
  "workspace_id": "text",
  "name": "text",
  "description": "text",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "query": "text",
  "target": "text",
  "enabled": true,
  "created_at": "text",
  "updated_at": "text"
}

Test a query tool with sample parameters

post

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

tool_idstring · uuidRequired

Body

application/json

Responses

200

Successful Response

application/json

columnsany ofOptional

string[]Optional

or

nullOptional

rowsany ofOptional

or

nullOptional

row_countintegerRequired

422

Validation error

429

Rate limited

post

/v1/{workspace_id}/query-tools/{tool_id}/test

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/query-tools/{tool_id}/test HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "columns": [
    "text"
  ],
  "rows": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "row_count": 1
}