Tools

Get Schema

Describe the organization's data schema.

Returns every table the agent can target, including its semantic category (e.g. raw vs. curated), description, and full column definitions with types, nullability, uniqueness, and foreign-key targets. Each column carries two names: 'name' is what the read and write tools accept, and 'sql_column_name' is the physical column for SQL queries (a column holding another row's key carries an _id suffix). The org's own tables are followed by the platform tables (core_experiment, core_instrument, and similar) that SQL queries can join against, ending with core_user, which holds the org's members; those have no id or semantic category. This is the map a parser writes into: use it to plan which tables to populate and how rows link.

Requires an API key with the read scope.

get/api/v1/tools/schema

Request

  • Base URL: https://platform.labric.co
  • URL: https://platform.labric.co/api/v1/tools/schema
  • Auth: HTTP bearer

Response

OK

idinteger nullable
namestring required
descriptionstring nullable
semantic_categorystring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.