ANTSAND Databoard API

Inspect a Databoard, patch structured data or Sass, compile utility CSS, deploy the generated site, and verify the artifact.

The safe loop is concrete: GET the board, POST a narrow patch, POST compile when styling changed, POST deploy, then POST verify.

API Reference

Start with a Bearer token

API keys identify the user, scope access, and keep board operations inside that user context.

Authentication

Required headers

Send the token on every request. Add Content-Type for JSON mutation calls.

HTTP headers http 
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Ownership model

The key resolves to a user_hash. Databoards, groups, websites, forms, and notes are read through that owner context.

Browser editing still uses normal sessions. API keys are for agents, CLI scripts, import/export workflows, and deployment automation.

Available API calls

Individual API calls available to agents and scripts. Use the workflow section below when you want the recommended order of operations.

Endpoint reference

/api/v1/me

Verify the API key, scopes, and user profile before touching a board.

/api/v1/me bash 
curl -X GET https://your-antsand-instance/api/v1/me \
  -H "Authorization: Bearer YOUR_API_KEY"
GET

/api/v1/databoards

List boards visible to the key and find the board id you intend to operate on.

/api/v1/databoards bash 
curl -X GET https://your-antsand-instance/api/v1/databoards \
  -H "Authorization: Bearer YOUR_API_KEY"
GET

/api/v1/databoards/{BOARD_ID}

Fetch the full board contract: pages, sections, menu data, mappings, Sass, HMVC, and website settings.

/api/v1/databoards/{BOARD_ID} bash 
curl -X GET https://your-antsand-instance/api/v1/databoards/abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"
GET

/api/v1/databoards/{BOARD_ID}/patch

Apply patch_delta operations for menu data, section mapping, Sass files, routes, ACL, and global references.

/api/v1/databoards/{BOARD_ID}/patch bash 
curl -X POST https://your-antsand-instance/api/v1/databoards/abc123/patch \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @patch_delta.json
POST

/api/v1/databoards/{BOARD_ID}/utilities/compile

Compile board-local utility CSS after adding or changing css_class values.

/api/v1/databoards/{BOARD_ID}/utilities/compile bash 
curl -X POST https://your-antsand-instance/api/v1/databoards/abc123/utilities/compile \
  -H "Authorization: Bearer YOUR_API_KEY"
POST

/api/v1/databoards/{BOARD_ID}/deploy

Generate the HMVC site artifact, routes, views, Sass, JS assets, API data, and deployment files.

/api/v1/databoards/{BOARD_ID}/deploy bash 
curl -X POST https://your-antsand-instance/api/v1/databoards/abc123/deploy \
  -H "Authorization: Bearer YOUR_API_KEY"
POST

/api/v1/databoards/{BOARD_ID}/verify-deployment

Check generated routes, ACL resources, controller actions, metadata, internal forms, and interactive assets.

/api/v1/databoards/{BOARD_ID}/verify-deployment bash 
curl -X POST https://your-antsand-instance/api/v1/databoards/abc123/verify-deployment \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"strict":true}'
POST

Databoard field to rendered HTML

This table uses the existing Databoard static datatable renderer. Classes assigned in Databoard are appended to fixed renderer classes.

Field Map
Field Element Fixed Class Purpose
section.container <section> .section Theme and outer spacing classes.
data.container <div> .data-container Grid/flex layout classes.
data.sub_container <div> per item .data-sub-container Card wrapper classes.
data.img_container <div> wrapping image .data-img-container Aspect ratio and media layout.
data.h3 <h3> .data-h3 Title typography.
data.p <p> .data-p Body copy typography.
data.cta <a> .data-cta Button and link styling.

Copyable API workflow

Use this sequence when an agent or script changes a generated ANTSAND site. Each step is an actual API call.

Executable loop

1. Inspect the board

Read pages, sections, menu data, data_mapping, Sass, HMVC routes, and website settings before changing anything.

inspect board bash 
curl -X GET https://your-antsand-instance/api/v1/databoards/BOARD_ID \
  -H "Authorization: Bearer YOUR_API_KEY"
GET

2. Apply a narrow patch

Patch menu data, section classes, Sass files, routes, ACL, or global references without rewriting the full board.

patch board bash 
curl -X POST https://your-antsand-instance/api/v1/databoards/BOARD_ID/patch \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @patch_delta.json
POST

3. Compile utilities when CSS changed

Run this after adding or changing css_class values so board-local utility CSS is regenerated.

compile utilities bash 
curl -X POST https://your-antsand-instance/api/v1/databoards/BOARD_ID/utilities/compile \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"deploy":false}'
POST

4. Deploy the generated site

Generate HMVC routes, views, Sass, JS assets, API data, metadata, and deployment files.

deploy site bash 
curl -X POST https://your-antsand-instance/api/v1/databoards/BOARD_ID/deploy \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"website_id":"WEBSITE_ID","alias":"ALIAS","group_id":"GROUP_ID"}'
POST

5. Verify before promoting

Check generated routes, ACL resources, controller actions, metadata, internal forms, and interactive assets.

verify deployment bash 
curl -X POST https://your-antsand-instance/api/v1/databoards/BOARD_ID/verify-deployment \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"website_id":"WEBSITE_ID","alias":"ALIAS","group_id":"GROUP_ID","strict":true}'
POST
AI Quick Start Databoard Concept

ANTSAND

AI-readable CSS, Header/Body/Footer contracts, and generated-site hardening across the ANTSAND ecosystem.

ANTSAND Styles v2 - Open Source CSS Framework