Content Box API

The Content Box system provides a schematized storage layer for unstructured or custom-structured data. It allows organizations to define complex data models (Types) and instantiate them as managed content entities (Contents), suitable for blogs, product catalogs, and internal metadata repositories.

Content Entity Management

Manage the lifecycle of data entries within your defined content structures.

List Content Entities

Retrieve a paginated collection of content entities. Results can be filtered by state, content type, or via a full-text search query.

{
  "entities": "Contents",
  "count": 12,
  "per_page": 50,
  "elements": [
    {
      "id": "6768...",
      "type_id": "6751...",
      "title": "Q1 Product Launch",
      "state": "public",
      "data": {
        "headline": "Introducing the 2026 Fleet",
        "hero_image": "https://cdn.acme.com/img/l1.jpg",
        "featured": true
      }
    }
  ]
}

Create Content Entity

Provision a new content entry. The data payload must adhere to the requirements of the associated type_id.

{
  "content": {
    "title": "Annual Sustainability Report",
    "type_id": "675112233b498f30",
    "state": "draft",
    "data": {
      "period": "2025",
      "impact_score": 92
    }
  }
}

{
  "id": "6768..."
}

Update Content Entity

Modify an existing content entry. This endpoint supports partial updates; only the fields provided in the content object will be modified.

{
  "content": {
    "state": "public",
    "data": {
      "revised_at": "2026-03-01T10:00:00Z"
    }
  }
}

{
  "id": "6768...",
  "updated": true
}

Retrieve Content Entity

Fetch the full payload for a single content entry.

{
  "id": "6768...",
  "title": "Q1 Product Launch",
  "state": "public",
  "data": {}
}

{
  "error": "Content Box not found"
}

Decommission Content Entity

Permanently delete a content entry. This action is irreversible.

{
  "id": "6768...",
  "deleted": true
}

Content Type Modeling (Schema Definition)

Define and manage the structural blueprints that govern how content is stored and validated.

List Content Types

Retrieve the catalog of all defined content schemas for your organization.

{
  "entities": "Types",
  "count": 1,
  "elements": [
    {
      "id": "6751...",
      "title": "Corporate Blog",
      "description": "Schema for official news",
      "fields": {
        "author": {
          "label": "Author",
          "type": "string"
        }
      }
    }
  ]
}

Create Content Type

Define a new organizational schema. Specify the attributes and UI input types for each field in the model.

{
  "type": {
    "title": "E-Commerce Product",
    "description": "Standardized schema for catalog items.",
    "fields": {
      "sku": {
        "label": "SKU",
        "type": "string"
      },
      "price": {
        "label": "Unit Price",
        "type": "string"
      },
      "in_stock": {
        "label": "Inventory Status",
        "type": "checkbox"
      }
    }
  }
}

{
  "id": "6751...",
  "title": "E-Commerce Product"
}

Retrieve Type Definition

Fetch the precise structural definition for a specific content type.

{
  "id": "6751...",
  "title": "Corporate Blog",
  "fields": {}
}

Update Type Definition

Update metadata or fields for a specific content schema. When fields is provided, each field must include both label and type and use allowed input types.

{
  "type": {
    "title": "Corporate Blog",
    "description": "Schema for official company news",
    "fields": {
      "author": {
        "label": "Author",
        "type": "string"
      },
      "hero_image": {
        "label": "Hero Image",
        "type": "url"
      }
    }
  }
}

{
  "id": "6751...",
  "title": "Corporate Blog",
  "description": "Schema for official company news",
  "fields": {}
}

{
  "error": "Fields must be an associative array"
}