Databases API — Agentuity Documentation

Databases API

Execute queries, inspect tables, and monitor database performance

Execute queries, inspect tables, and monitor database performance.

https://catalyst-usw.agentuity.cloud

Authentication

All requests require a Bearer token. Pass your SDK key in the Authorization header.

HeaderValue
AuthorizationBearer YOUR_SDK_KEY

You can find your SDK key in the Agentuity Console under your project settings.


Get Query Logs

Get query logs for a database with optional filtering.

GET/resource/{orgId}/{region}/{database}/logs
https://catalyst-usw.agentuity.cloud/resource/{orgId}/{region}/{database}/logs

Parameters

path
NameTypeRequiredDescription
orgIdstringYesOrganization ID
regionstringYesRegion identifier
databasestringYesDatabase name
query
NameTypeRequiredDescription
startDatestringNoStart date filter
endDatestringNoEnd date filter
usernamestringNoFilter by username
commandstringNoFilter by SQL command type
hasErrorbooleanNoFilter for queries with errors
sessionIdstringNoFilter by session ID
limitnumberNoMaximum logs to return

Response

Array of query log entries.

StatusDescription
200Query logs returned
401Unauthorized — invalid or missing Bearer token
404Database not found

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/resource/org_abc123/usw/mydb/logs' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Execute Query

Execute a SQL query against a database.

POST/resource/{orgId}/{region}/{database}/query
https://catalyst-usw.agentuity.cloud/resource/{orgId}/{region}/{database}/query

Parameters

path
NameTypeRequiredDescription
orgIdstringYesOrganization ID
regionstringYesRegion identifier
databasestringYesDatabase name

Request Body

SQL query payload.

FieldTypeDescription
querystringSQL query to execute

Response

Returns columns, rows, row count, and whether results were truncated (max 1000 rows).

StatusDescription
200Query executed successfully
401Unauthorized — invalid or missing Bearer token
404Database not found

Example

curl -X POST 'https://catalyst-usw.agentuity.cloud/resource/org_abc123/usw/mydb/query' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "query": "SELECT * FROM users LIMIT 10"
}'

Get Query Stats

Get aggregate query statistics for a database over a date range.

GET/resource/{orgId}/{region}/{database}/logs/stats
https://catalyst-usw.agentuity.cloud/resource/{orgId}/{region}/{database}/logs/stats

Parameters

path
NameTypeRequiredDescription
orgIdstringYesOrganization ID
regionstringYesRegion identifier
databasestringYesDatabase name
query
NameTypeRequiredDescription
startDatestringYesStart date for stats range
endDatestringYesEnd date for stats range

Response

Aggregate query statistics.

StatusDescription
200Query stats returned
401Unauthorized — invalid or missing Bearer token
404Database not found

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/resource/org_abc123/usw/mydb/logs/stats' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

List Tables

List all tables in a database.

GET/resource/{orgId}/{region}/{database}/tables
https://catalyst-usw.agentuity.cloud/resource/{orgId}/{region}/{database}/tables

Parameters

path
NameTypeRequiredDescription
orgIdstringYesOrganization ID
regionstringYesRegion identifier
databasestringYesDatabase name

Response

Array of table names and metadata.

StatusDescription
200Tables returned
401Unauthorized — invalid or missing Bearer token
404Database not found

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/resource/org_abc123/usw/mydb/tables' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'