v1

latestOpenAPI 3.1.02026-07-263580186.3 KB
Facets

Browse content-type starter templates

Browse the platform's starter-kit templates for content types. These are ready-made taxonomies (legal, finance, healthcare, tech, manufacturing) you can adopt to quickly organise your documents, no manual setup required.

Getting started:

  1. Browse templates here to see what's available
  2. Adopt the ones you need: POST /api/v3/content-types {"action": "adopt", "paths": ["legal", "finance"]}
  3. Once adopted, they become your company's own content types, fully editable
  4. Customize: rename nodes, add children, define new attributes, or delete what you don't need
  5. Create entirely new content types from scratch with define_content_type

All write operations happen on POST /api/v3/content-types. This endpoint is read-only: it shows the catalog of available templates.

After adoption, manage your company's content types (adopted + custom) via GET /api/v3/content-types and POST /api/v3/content-types. Classify files with POST /api/v3/files/{id}/facets.

Query modes:

  • No params → full detail for all templates (children + attributes)
  • ?path=legal → detail for one template
  • ?path=legal,finance → detail for multiple (comma-separated)
  • ?path=legal:contract:nda → detail for a nested node
  • ?depth=0 → root info only (code, label, description, no children/attributes)
  • ?depth=1 → roots + direct children only
  • ?include_attributes=false: omit attribute definitions for a lighter response

Path separator: : (colon). Example: legal:contract:nda

Attribute inheritance: Attributes defined at a parent node are inherited by all its children. A document classified as legal:contract:nda gets attributes from legal, legal:contract, and legal:contract:nda.

get/api/v3/content-types/templates

Query parameters

depthinteger

Tree depth limit. Default (omitted) = full tree. 0 = root info only (no children, no attributes). 1 = roots + direct children. N = N levels of children.

include_attributesboolean

Include attribute definitions per content type node. Default: true.

pathstring

Content type path(s), colon-separated hierarchy. Comma-separated for multiple (e.g., ?path=legal,finance, ?path=tech,manufacturing, or ?path=legal:contract:nda). Root codes: finance, healthcare, legal, manufacturing, tech

Response

Content types returned successfully