Fields and relationships
describe_entityShow an entity's selectable fields and its declared relationships to other entities. An entity modelled automatically can carry hundreds of fields, so the most-filled ones are returned by default and 'fields_selection' says how many were not — use 'matching' to search by name, 'fields' to name the ones you want, or 'offset' to page. A field not shown is not thereby absent. The field names here are the ones query accepts. Relationships listed here are the ONLY joins available — they are declared by the data model, never inferred.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | how many fields to describe; default 40, maximum 200 | |
| model | No | model name; omit for the default | |
| entity | Yes | the entity name, from list_entities | |
| fields | No | describe only these fields; omit for the most-filled ones | |
| offset | No | skip this many fields; use with the reported total to page through them all | |
| matching | No | describe only fields whose name or description contains this |