Tools API

Available AI tools for data modeling operations

20 tools available
Filter by category: All attributes entities model notes other relationships
other list_entities 2 parameters
List entities in the current project
Response Fields
Field Type Description
id string UUID
name string Entity name
business_domain string|null Business domain for semantic models
color string|null Optional color hex
created_at datetime Creation timestamp
database_name string|null Database name
deleted boolean Soft delete flag
description string|null Optional description
entity_type enum[EntityType]
TABLE | VIEW | CONCEPT | FILE
 TABLE, VIEW, CONCEPT, or FILE
height integer Entity height in pixels
is_virtual boolean|null Whether entity is virtual
materialization_type enum[MaterializationType]|null
VIEW | MATERIALIZED_VIEW | DYNAMIC_TABLE
 VIEW, MATERIALIZED_VIEW, or DYNAMIC_TABLE
model_id string Parent model UUID
origin string|null Origin/source information
physical_name string|null Physical name for DB entities
schema_name string|null Database schema name
updated_at datetime Last update timestamp
use_type enum[UseType]|null
SOURCE | TRANSFORM | OUTPUT
 SOURCE, TRANSFORM, or OUTPUT
version integer Version number for optimistic locking
width integer Entity width in pixels
x integer X coordinate on canvas
y integer Y coordinate on canvas
API Parameters
Name Type Required Description
model_id string No Optional model id filter
limit integer No No description
min: 1 , max: 200
Try It
JSON endpoint: /tools/list_entities
attributes list_attributes 2 parameters
List attributes for an entity in the current project
Response Fields
Field Type Description
id string UUID
name string Attribute name
business_type string|null Business type classification
business_type_attributes json|null Additional business type metadata
created_at datetime Creation timestamp
data_subtype string|null Additional type information
data_type enum[DataType]
STRING | BOOLEAN | INTEGER | DECIMAL | FLOAT | DATE | DATETIME | TIME | JSON | BLOB
 Data type
date_format string|null Date format pattern
deleted boolean Soft delete flag
description string|null Optional description
entity_id string Parent entity UUID
enum_values string[]|null Enum values for enum types
interface_links string[] List of linked interface UUIDs
is_array boolean Array type flag
is_autoincrement boolean Auto-increment flag
is_foreign_key boolean Foreign key flag
is_nullable boolean Nullable flag (true if column can be NULL)
is_primary_key boolean Primary key flag
is_unique boolean Unique constraint flag
max_length integer|null Maximum length constraint
max_value number|null Maximum value constraint
min_length integer|null Minimum length constraint
min_value number|null Minimum value constraint
order integer Display order within entity
origin string|null Origin/source information
physical_name string|null Physical column name
precision integer|null Decimal precision
updated_at datetime Last update timestamp
version integer Version number
API Parameters
Name Type Required Description
entity_id string Yes No description
limit integer No No description
min: 1 , max: 200
Try It
JSON endpoint: /tools/list_attributes
notes list_notes 3 parameters
List notes in the current project
Response Fields
Field Type Description
id string UUID
name string Note name
color string|null Background color hex
comments array List of comments on this note
created_at datetime Creation timestamp
deleted boolean Soft delete flag
description string|null Optional description
font_size integer|null Font size in pixels
height integer Note height in pixels
linked_to_id string|null Target object UUID
linked_to_type enum[LinkTarget]
MODEL | ENTITY | ATTRIBUTE | RELATIONSHIP | INTERFACE
 Target type
model_id string Model UUID this note belongs to
note_type enum[NoteType]
INFO | WARNING | TODO | FIXME | COMMENT
 Note type
solved boolean Whether the note is solved/resolved
text string Note text content
updated_at datetime Last update timestamp
version integer Version number
width integer Note width in pixels
x integer X coordinate on canvas
y integer Y coordinate on canvas
API Parameters
Name Type Required Description
target_type string No One of: MODEL, ENTITY, ATTRIBUTE, RELATIONSHIP
target_id string No No description
limit integer No No description
min: 1 , max: 200
Try It
JSON endpoint: /tools/list_notes
relationships list_relationships 2 parameters
List relationships in the current project. Fields: id, model_id, source_entity_id, target_entity_id, source_attribute_id, target_attribute_id, relationship_type, is_source_nullable, is_target_nullable, x, y, created_at, updated_at, version, deleted. Enums: RelationshipType(ONE_TO_ONE, ONE_TO_MANY, MANY_TO_ONE, MANY_TO_MANY, MAPPING, RELATED)
API Parameters
Name Type Required Description
model_id string No No description
limit integer No No description
min: 1 , max: 200
Try It
JSON endpoint: /tools/list_relationships
entities create_entity 2 parameters
Create a new entity
Request Fields
Field Type Description
name str Entity name
description str | None Optional long description
x int Canvas X position (px)
y int Canvas Y position (px)
color str | None Optional color token/HEX
entity_type str | None Logical type of the entity (EntityType)
materialization_type str | None Materialization semantics (MaterializationType)
physical_name str | None Physical name in source system
use_type str | None Intended use of the entity (UseType)
dwh_use_type str | None Data warehouse use type (DwhUseType)
scd_type str | None Slowly Changing Dimension type (SCDType)
file_type str | None File format type (FileType)
dialect str | None SQL dialect for this entity
business_domain str | None Business domain or categorization
schema_name str | None Database schema name
database_name str | None Database name.
Response Fields
Field Type Description
id string UUID
name string Entity name
business_domain string|null Business domain for semantic models
color string|null Optional color hex
created_at datetime Creation timestamp
database_name string|null Database name
deleted boolean Soft delete flag
description string|null Optional description
entity_type enum[EntityType]
TABLE | VIEW | CONCEPT | FILE
 TABLE, VIEW, CONCEPT, or FILE
height integer Entity height in pixels
is_virtual boolean|null Whether entity is virtual
materialization_type enum[MaterializationType]|null
VIEW | MATERIALIZED_VIEW | DYNAMIC_TABLE
 VIEW, MATERIALIZED_VIEW, or DYNAMIC_TABLE
model_id string Parent model UUID
origin string|null Origin/source information
physical_name string|null Physical name for DB entities
schema_name string|null Database schema name
updated_at datetime Last update timestamp
use_type enum[UseType]|null
SOURCE | TRANSFORM | OUTPUT
 SOURCE, TRANSFORM, or OUTPUT
version integer Version number for optimistic locking
width integer Entity width in pixels
x integer X coordinate on canvas
y integer Y coordinate on canvas
API Parameters
Name Type Required Description
model_id string Yes No description
data object Yes No description
Try It
JSON endpoint: /tools/create_entity
entities update_entity 3 parameters
Update an existing entity
Request Fields
Field Type Description
name str | None Entity name
entity_id str Entity identifier (UUID)
description str | None Optional long description
color str | None Optional color token/HEX
physical_name str | None Physical name in source system
use_type str | None Intended use of the entity (UseType)
dwh_use_type str | None Data warehouse use type (DwhUseType)
entity_type str | None Logical type of the entity (EntityType)
materialization_type str | None Materialization semantics (MaterializationType)
scd_type str | None Slowly Changing Dimension type (SCDType)
file_type str | None File format type (FileType)
dialect str | None SQL dialect for this entity
business_domain str | None Business domain or categorization
schema_name str | None Database schema name
database_name str | None Database name.
Response Fields
Field Type Description
id string UUID
name string Entity name
business_domain string|null Business domain for semantic models
color string|null Optional color hex
created_at datetime Creation timestamp
database_name string|null Database name
deleted boolean Soft delete flag
description string|null Optional description
entity_type enum[EntityType]
TABLE | VIEW | CONCEPT | FILE
 TABLE, VIEW, CONCEPT, or FILE
height integer Entity height in pixels
is_virtual boolean|null Whether entity is virtual
materialization_type enum[MaterializationType]|null
VIEW | MATERIALIZED_VIEW | DYNAMIC_TABLE
 VIEW, MATERIALIZED_VIEW, or DYNAMIC_TABLE
model_id string Parent model UUID
origin string|null Origin/source information
physical_name string|null Physical name for DB entities
schema_name string|null Database schema name
updated_at datetime Last update timestamp
use_type enum[UseType]|null
SOURCE | TRANSFORM | OUTPUT
 SOURCE, TRANSFORM, or OUTPUT
version integer Version number for optimistic locking
width integer Entity width in pixels
x integer X coordinate on canvas
y integer Y coordinate on canvas
API Parameters
Name Type Required Description
model_id string Yes No description
entity_id string Yes No description
data object Yes No description
Try It
JSON endpoint: /tools/update_entity
entities delete_entity 2 parameters
Delete an entity by id
API Parameters
Name Type Required Description
model_id string Yes No description
entity_id string Yes No description
Try It
JSON endpoint: /tools/delete_entity
entities move_entity 4 parameters
Move an entity
Request Fields
Field Type Description
entity_id str Entity identifier (UUID)
x int New canvas X position (px)
y int New canvas Y position (px).
Response Fields
Field Type Description
id string UUID
name string Entity name
business_domain string|null Business domain for semantic models
color string|null Optional color hex
created_at datetime Creation timestamp
database_name string|null Database name
deleted boolean Soft delete flag
description string|null Optional description
entity_type enum[EntityType]
TABLE | VIEW | CONCEPT | FILE
 TABLE, VIEW, CONCEPT, or FILE
height integer Entity height in pixels
is_virtual boolean|null Whether entity is virtual
materialization_type enum[MaterializationType]|null
VIEW | MATERIALIZED_VIEW | DYNAMIC_TABLE
 VIEW, MATERIALIZED_VIEW, or DYNAMIC_TABLE
model_id string Parent model UUID
origin string|null Origin/source information
physical_name string|null Physical name for DB entities
schema_name string|null Database schema name
updated_at datetime Last update timestamp
use_type enum[UseType]|null
SOURCE | TRANSFORM | OUTPUT
 SOURCE, TRANSFORM, or OUTPUT
version integer Version number for optimistic locking
width integer Entity width in pixels
x integer X coordinate on canvas
y integer Y coordinate on canvas
API Parameters
Name Type Required Description
model_id string Yes No description
entity_id string Yes No description
x integer Yes No description
y integer Yes No description
Try It
JSON endpoint: /tools/move_entity
attributes create_attribute 3 parameters
Create a new attribute
Request Fields
Field Type Description
name str Attribute name
entity_id str Owning entity identifier (UUID)
description str | None Optional long description
physical_name str | None Physical/DB column name
origin str | None Origin system or lineage hint
data_type str Logical data type (DataType)
dialect_type str | None Dialect-specific type (e.g., VARCHAR, BIGINT)
dialect str | None SQL dialect for the dialect_type
business_type str | None Business semantic type (e.g., EMAIL, CREDIT_CARD_NUMBER)
business_type_params typing.Any | None Custom parameters for business type
data_type_info typing.Any | None Full data type info (DataTypeInfo)
order int Display/order index within the entity
scale int | None Scale for decimal types
is_primary_key bool Marks this attribute as part of the primary key
is_foreign_key bool Marks this attribute as part of a foreign key
is_unique bool Unique constraint enforced
is_autoincrement bool Auto-incrementing numeric field
is_surrogate_key bool Surrogate key column
is_business_key bool Business key column
is_audit_column bool Audit tracking column
is_scd_column bool SCD tracking column
audit_role str | None Audit column role (AuditRole)
scd_role str | None SCD column role (SCDRole)
pii_level str | None PII classification level (PIILevel)
pcidss_attribute str | None PCI DSS attribute type (PCIDSSAttribute)
hipaa_identifier str | None HIPAA identifier type (HIPAAIdentifier).
Response Fields
Field Type Description
id string UUID
name string Attribute name
business_type string|null Business type classification
business_type_attributes json|null Additional business type metadata
created_at datetime Creation timestamp
data_subtype string|null Additional type information
data_type enum[DataType]
STRING | BOOLEAN | INTEGER | DECIMAL | FLOAT | DATE | DATETIME | TIME | JSON | BLOB
 Data type
date_format string|null Date format pattern
deleted boolean Soft delete flag
description string|null Optional description
entity_id string Parent entity UUID
enum_values string[]|null Enum values for enum types
interface_links string[] List of linked interface UUIDs
is_array boolean Array type flag
is_autoincrement boolean Auto-increment flag
is_foreign_key boolean Foreign key flag
is_nullable boolean Nullable flag (true if column can be NULL)
is_primary_key boolean Primary key flag
is_unique boolean Unique constraint flag
max_length integer|null Maximum length constraint
max_value number|null Maximum value constraint
min_length integer|null Minimum length constraint
min_value number|null Minimum value constraint
order integer Display order within entity
origin string|null Origin/source information
physical_name string|null Physical column name
precision integer|null Decimal precision
updated_at datetime Last update timestamp
version integer Version number
API Parameters
Name Type Required Description
model_id string Yes No description
entity_id string Yes No description
data object Yes No description
Try It
JSON endpoint: /tools/create_attribute
attributes update_attribute 3 parameters
Update an attribute
Request Fields
Field Type Description
name str | None Attribute name
attribute_id str Attribute identifier (UUID)
entity_id str | None Owning entity identifier (UUID)
description str | None Optional long description
physical_name str | None Physical/DB column name
origin str | None Origin system or lineage hint
data_type str | None Logical data type (DataType)
dialect_type str | None Dialect-specific type (e.g., VARCHAR, BIGINT)
dialect str | None SQL dialect for the dialect_type
business_type str | None Business semantic type (e.g., EMAIL, CREDIT_CARD_NUMBER)
business_type_params typing.Any | None Custom parameters for business type
data_type_info typing.Any | None Full data type info (DataTypeInfo)
order int | None Display/order index within the entity
scale int | None Scale for decimal types
is_primary_key bool | None Marks this attribute as part of the primary key
is_foreign_key bool | None Marks this attribute as part of a foreign key
is_unique bool | None Unique constraint enforced
is_autoincrement bool | None Auto-incrementing numeric field
is_surrogate_key bool | None Surrogate key column
is_business_key bool | None Business key column
is_audit_column bool | None Audit tracking column
is_scd_column bool | None SCD tracking column
audit_role str | None Audit column role (AuditRole)
scd_role str | None SCD column role (SCDRole)
pii_level str | None PII classification level (PIILevel)
pcidss_attribute str | None PCI DSS attribute type (PCIDSSAttribute)
hipaa_identifier str | None HIPAA identifier type (HIPAAIdentifier).
Response Fields
Field Type Description
id string UUID
name string Attribute name
business_type string|null Business type classification
business_type_attributes json|null Additional business type metadata
created_at datetime Creation timestamp
data_subtype string|null Additional type information
data_type enum[DataType]
STRING | BOOLEAN | INTEGER | DECIMAL | FLOAT | DATE | DATETIME | TIME | JSON | BLOB
 Data type
date_format string|null Date format pattern
deleted boolean Soft delete flag
description string|null Optional description
entity_id string Parent entity UUID
enum_values string[]|null Enum values for enum types
interface_links string[] List of linked interface UUIDs
is_array boolean Array type flag
is_autoincrement boolean Auto-increment flag
is_foreign_key boolean Foreign key flag
is_nullable boolean Nullable flag (true if column can be NULL)
is_primary_key boolean Primary key flag
is_unique boolean Unique constraint flag
max_length integer|null Maximum length constraint
max_value number|null Maximum value constraint
min_length integer|null Minimum length constraint
min_value number|null Minimum value constraint
order integer Display order within entity
origin string|null Origin/source information
physical_name string|null Physical column name
precision integer|null Decimal precision
updated_at datetime Last update timestamp
version integer Version number
API Parameters
Name Type Required Description
model_id string Yes No description
attribute_id string Yes No description
data object Yes No description
Try It
JSON endpoint: /tools/update_attribute
attributes delete_attribute 2 parameters
Delete an attribute by id
API Parameters
Name Type Required Description
model_id string Yes No description
attribute_id string Yes No description
Try It
JSON endpoint: /tools/delete_attribute
notes create_note 3 parameters
Create a note
Request Fields
Field Type Description
text str Note text content
x int Canvas X position (px)
y int Canvas Y position (px)
width int Canvas width (px)
height int Canvas height (px)
color str | None Optional color token/HEX
font_size int | None Optional font size (px)
linked_to_type str Type of linked target (LinkTarget)
linked_to_id str | None ID of linked target
note_type str Note type: INFO, WARNING, TODO, FIXME, COMMENT
solved bool Whether the note is solved/resolved.
Response Fields
Field Type Description
id string UUID
name string Note name
color string|null Background color hex
comments array List of comments on this note
created_at datetime Creation timestamp
deleted boolean Soft delete flag
description string|null Optional description
font_size integer|null Font size in pixels
height integer Note height in pixels
linked_to_id string|null Target object UUID
linked_to_type enum[LinkTarget]
MODEL | ENTITY | ATTRIBUTE | RELATIONSHIP | INTERFACE
 Target type
model_id string Model UUID this note belongs to
note_type enum[NoteType]
INFO | WARNING | TODO | FIXME | COMMENT
 Note type
solved boolean Whether the note is solved/resolved
text string Note text content
updated_at datetime Last update timestamp
version integer Version number
width integer Note width in pixels
x integer X coordinate on canvas
y integer Y coordinate on canvas
API Parameters
Name Type Required Description
linked_to_type string Yes One of: MODEL, ENTITY, ATTRIBUTE, RELATIONSHIP
linked_to_id string No No description
data object Yes No description
Try It
JSON endpoint: /tools/create_note
notes update_note 2 parameters
Update a note
Request Fields
Field Type Description
note_id str Note identifier (UUID)
text str | None Note text content
width int | None Canvas width (px)
height int | None Canvas height (px)
color str | None Optional color token/HEX
font_size int | None Optional font size (px)
linked_to_type str | None Type of linked target (LinkTarget)
linked_to_id str | None ID of linked target
note_type str | None Note type: INFO, WARNING, TODO, FIXME, COMMENT
solved bool | None Whether the note is solved/resolved.
Response Fields
Field Type Description
id string UUID
name string Note name
color string|null Background color hex
comments array List of comments on this note
created_at datetime Creation timestamp
deleted boolean Soft delete flag
description string|null Optional description
font_size integer|null Font size in pixels
height integer Note height in pixels
linked_to_id string|null Target object UUID
linked_to_type enum[LinkTarget]
MODEL | ENTITY | ATTRIBUTE | RELATIONSHIP | INTERFACE
 Target type
model_id string Model UUID this note belongs to
note_type enum[NoteType]
INFO | WARNING | TODO | FIXME | COMMENT
 Note type
solved boolean Whether the note is solved/resolved
text string Note text content
updated_at datetime Last update timestamp
version integer Version number
width integer Note width in pixels
x integer X coordinate on canvas
y integer Y coordinate on canvas
API Parameters
Name Type Required Description
note_id string Yes No description
data object Yes No description
Try It
JSON endpoint: /tools/update_note
notes move_note 3 parameters
Move a note
Request Fields
Field Type Description
note_id str
x int
y int .
Response Fields
Field Type Description
id string UUID
name string Note name
color string|null Background color hex
comments array List of comments on this note
created_at datetime Creation timestamp
deleted boolean Soft delete flag
description string|null Optional description
font_size integer|null Font size in pixels
height integer Note height in pixels
linked_to_id string|null Target object UUID
linked_to_type enum[LinkTarget]
MODEL | ENTITY | ATTRIBUTE | RELATIONSHIP | INTERFACE
 Target type
model_id string Model UUID this note belongs to
note_type enum[NoteType]
INFO | WARNING | TODO | FIXME | COMMENT
 Note type
solved boolean Whether the note is solved/resolved
text string Note text content
updated_at datetime Last update timestamp
version integer Version number
width integer Note width in pixels
x integer X coordinate on canvas
y integer Y coordinate on canvas
API Parameters
Name Type Required Description
note_id string Yes No description
x integer Yes No description
y integer Yes No description
Try It
JSON endpoint: /tools/move_note
notes delete_note 1 parameters
Delete a note by id
API Parameters
Name Type Required Description
note_id string Yes No description
Try It
JSON endpoint: /tools/delete_note
relationships create_relationship 2 parameters
Create a relationship
Request Fields
Field Type Description
name str | None Optional relationship name
description str | None Optional long description
source_entity_id str Source entity id
source_attribute_id str Source attribute id
target_entity_id str Target entity id
target_attribute_id str Target attribute id
relationship_type str Type of relationship: ONE_TO_ONE, ONE_TO_MANY, MANY_TO_ONE, MANY_TO_MANY, MAPPING, RELATED
is_source_nullable bool Whether the source side is nullable
is_target_nullable bool Whether the target side is nullable.
Response Fields
Field Type Description
id string UUID
name string Relationship name
created_at datetime Creation timestamp
deleted boolean Soft delete flag
description string|null Optional description
is_source_nullable boolean Source side nullable
is_target_nullable boolean Target side nullable
relationship_type enum[RelationshipType]
ONE_TO_ONE | ONE_TO_MANY | MANY_TO_ONE | MANY_TO_MANY
 Relationship cardinality
source_attribute_id string|null Source attribute UUID
source_entity_id string Source entity UUID
target_attribute_id string|null Target attribute UUID
target_entity_id string Target entity UUID
updated_at datetime Last update timestamp
version integer Version number
API Parameters
Name Type Required Description
model_id string Yes No description
data object Yes No description
Try It
JSON endpoint: /tools/create_relationship
relationships update_relationship 3 parameters
Update a relationship by id. Fields supported: id, model_id, source_entity_id, target_entity_id, source_attribute_id, target_attribute_id, relationship_type, is_source_nullable, is_target_nullable, x, y, created_at, updated_at, version, deleted
API Parameters
Name Type Required Description
model_id string Yes No description
relationship_id string Yes No description
data object Yes No description
Try It
JSON endpoint: /tools/update_relationship
relationships delete_relationship 2 parameters
Delete a relationship by id
API Parameters
Name Type Required Description
model_id string Yes No description
relationship_id string Yes No description
Try It
JSON endpoint: /tools/delete_relationship
model get_project_model 8 parameters
Read the full current project model with all its components. Returns models, entities, attributes, relationships, notes, tags, and interfaces. Use the include_* flags to filter which components to return
API Parameters
Name Type Required Description
model_id string No Optional specific model ID. If not provided, returns all models in project.
include_entities boolean No Include entities in the response
include_attributes boolean No Include attributes in the response
include_relationships boolean No Include relationships in the response
include_notes boolean No Include notes in the response
include_tags boolean No Include tags in the response
include_interfaces boolean No Include interfaces in the response
limit integer No Limit the number of items per category
min: 1 , max: 200
Try It
JSON endpoint: /tools/get_project_model
model modify_project_model 5 parameters
Unified tool for modifying the project model. Supports INSERT, UPDATE, DELETE operations on entity, attribute, tag, note, interface, and relationship types. For INSERT: provide operation='INSERT', target_type, model_id, and data. For UPDATE: provide operation='UPDATE', target_type, model_id, entity_id, and data. For DELETE: provide operation='DELETE', target_type, model_id, and entity_id
API Parameters
Name Type Required Description
operation string
enum: INSERT, UPDATE, DELETE
 Yes The operation to perform
target_type string
enum: entity, attribute, tag, note, interface, relationship
 Yes The type of object to modify
model_id string Yes The model ID to operate on
entity_id string No The ID of the entity to UPDATE or DELETE (required for those operations)
data object No The data for INSERT or UPDATE operations (JSON object with parameters)
Try It
JSON endpoint: /tools/modify_project_model
API Usage

Execute tools programmatically via POST /tools/call:

{
  "tool_name": "create_entity",
  "project_id": "your-project-uuid",
  "user_id": "your-user-uuid",
  "arguments": {
    "model_id": "your-model-uuid",
    "data": {
      "name": "Customer",
      "entity_type": "TABLE",
      "x": 100,
      "y": 200
    }
  }
}