RArastro-ai
Catalog Schemas

Add Catalog Field Public

Add a new field to the catalog schema (API key or user token).

Creates a new schema version with the additional field.

post/public/catalogs/{catalog_id}/schema/fields

Request

  • Base URL
    https://catalogapi.rastro.ai/api
  • Auth
    HTTP bearer

Path parameters

catalog_idstring required

Headers

X-Organization-Idstring nullable

Request body

field_namestring required

Name of the field to add

field_typestring required

Field type: string, number, boolean, array, object

descriptionstring nullable

Field description

requiredboolean

Whether field is required

scopestring

Field scope: variant, product, both. Accepted by the request model; the single-field public route does not apply scope metadata.

field_categorystring

Field category: input or generated. Stored as workflow-tracking metadata when workflow_id is provided.

positionstring

Where to add field: top or bottom

workflow_idstring nullable

Workflow ID that's adding this field

validation_rulesobject nullable

JSON Schema validation rules (pattern, enum, minLength, etc.)

unitstring nullable

Unit of measurement (e.g., 'V', 'W', 'kg', 'm')

sample_valuesstring[] nullable

Sample values to help understand expected formats

Response

Successful Response

successboolean required
catalog_idstring required
new_schema_versionstring required
previous_schema_versionstring required
fields_addedstring[]
fields_updatedstring[]
fields_removedstring[]
messagestring required

Changes

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