USuseboom
Initiatives

Set extraction schema

Changed on

Author or replace an initiative's extraction schema — the typed fields (bool/int/enum/string) pulled from each conversation. Replaces the schema wholesale; submit the complete set of fields, not a diff. A version is created only when the schema actually changes.

post/api/v1/initiatives/{id}/extraction-schema

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Path parameters

idstring required

The initiative id.

Request body

notesstring

Optional note recorded on this schema version.

Response

Success

initiativeIdstring required
versioninteger required

The extraction schema version now current for the initiative. Unchanged when the submitted schema was semantically identical to the current one.

changedboolean required

Whether a new version was created. False when the submitted schema was semantically identical to the current one — no version bump, and the submitted notes were NOT recorded.

fieldCountinteger required

Number of fields in the schema.

notesstring nullable required

The note on the current version — not necessarily the submitted note when changed is false.

createdAtstring required

ISO 8601 timestamp of this version.

Changes