v12

latestOpenAPI 3.1.0AGPL-3.0raw.githubusercontent.com2026-05-286377631.6 MB
/api/database

GET /api/database/{id}/autocomplete_suggestions

Return a list of autocomplete suggestions for a given prefix, or substring. Should only specify one, but substring will have priority if both are present.

This is intended for use with the ACE Editor when the User is typing raw SQL. Suggestions include matching Tables and Fields in this Database.

Tables are returned in the format [table_name "Table"]; When Fields have a semantic_type, they are returned in the format [field_name "table_name base_type semantic_type"] When Fields lack a semantic_type, they are returned in the format [field_name "table_name base_type"]

get/api/database/{id}/autocomplete_suggestions

Path parameters

idinteger required

value must be an integer greater than zero.

Query parameters

prefixstring nullable
substringstring nullable

Response

Successful response