Skip to navigation

Working with Molecule Schemas

Find a schema's ID and field definitions, and filter molecules by schema.

Reading schemas and core schema CRUD are GA, with no header. A schema also decides a molecule’s salt-form role; see the concept model.

Discovering a schema

To create a molecule against a schema, you need its schemaId and the names of the fields it defines.

OperationEndpointStability
List schemasGET /molecule-schema/itemsGA
Get oneGET /molecule-schema/{molecule_schema_id}GA
List a schema’s field definitionsGET /molecule-schema/{molecule_schema_id}/field-definitions/itemsBeta
  • Take the schemaId from the list or get response, and pass it as schemaId on molecule create.
  • The field-definition listing tells you the field names and types to populate in schemaFields.

Filtering molecules by schema

To find molecules of a given schema, filter GET /molecule/items with schema.eq=<id> (one schema) or schema.anyOf=<id1>,<id2>,... (up to 100). Use only one schema filter argument at a time.