Get Schema

View as Markdown
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 (foreign keys carry 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; 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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

OK
namestring
columnslist of objects
idinteger or nullOptional
descriptionstring or nullOptional
semantic_categorystring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error