Skip to content

Custom Document Types API ​

Manage custom document types — user-defined templates for AI agent configurations, runbooks, and more.

See the full API reference: Custom Document Types API

Endpoints ​

MethodPathDescription
GET/api/v1/custom-document-typesList types
POST/api/v1/custom-document-typesCreate a type
GET/api/v1/custom-document-types/:idGet type detail
PATCH/api/v1/custom-document-types/:idUpdate a type
DELETE/api/v1/custom-document-types/:idDelete a type
POST/api/v1/custom-document-types/:id/promotePromote to company-wide

Quick Example ​

bash
# List all document types
curl -s http://localhost:3000/api/v1/custom-document-types \
  -H "Cookie: $SESSION_COOKIE" | jq '.[].name'

# Create a new type
curl -X POST http://localhost:3000/api/v1/custom-document-types \
  -H "Cookie: $SESSION_COOKIE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "AGENTS",
    "displayName": "Agent Configurations",
    "scope": "COMPANY",
    "metadataSchema": [
      {"name": "runtime", "type": "text", "required": true}
    ]
  }'