Brickworks — API Reference

Adapt, structure, and personalize experiences with AI-native content bricks. Go beyond headless CMS with behavioral AI that orchestrates content, decisions, and journeys in real time.

26 endpoints across 5 tags.

Brickworks: Schemas

• GET /brickworks/v1/schemas — Get schemas
• POST /brickworks/v1/schemas — Create schema
• GET /brickworks/v1/schemas/{SchemaIdentifier} — Get schema
• PUT /brickworks/v1/schemas/{SchemaIdentifier} — Update schema
• DELETE /brickworks/v1/schemas/{SchemaIdentifier} — Delete schema

Brickworks: Records

• GET /brickworks/v1/schemas/{SchemaIdentifier}/records — Get records from schema
• POST /brickworks/v1/schemas/{SchemaIdentifier}/records — Add record to schema
• GET /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier} — Get record
• PUT /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier} — Update record
• DELETE /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier} — Delete record
• POST /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/preview/by/{IdentifierType} — Preview object (as workspace)
• POST /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/preview — Preview object (as any consumer)
• POST /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/duplicate — Duplicate record
• POST /brickworks/v1/async/schemas/{SchemaIdentifier}/records — Batch create or update records (async)
• PATCH /brickworks/v1/async/schemas/{SchemaIdentifier}/records — Batch create or partially update record (async)
• POST /brickworks/v1/async/schemas/{SchemaIdentifier}/record — Create or update record (async)
• PATCH /brickworks/v1/async/schemas/{SchemaIdentifier}/record — Create or partially update record (async)

Brickworks: Content generation

• POST /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/generate/by/{IdentifierType} — Generate object from a record (as workspace)
• POST /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/generate — Generate object from a record (as any consumer)

Brickworks: External sources

• GET /brickworks/v1/external-sources — List external sources
• POST /brickworks/v1/external-sources — Create external source
• GET /brickworks/v1/external-sources/{ExternalDataSourceId} — Get External Source
• PUT /brickworks/v1/external-sources/{ExternalDataSourceId} — Update External Source
• DELETE /brickworks/v1/external-sources/{ExternalDataSourceId} — Delete external source

Brickworks: Record versions

• GET /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/versions — Get record versions
• GET /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/versions/{RecordVersionIdentifier} — Get record version

Back to all API categories