Build with Altask

Quickstart

Three minutes from a clean install to a deployed page. Pick your runtime — the snippet stays the same.

// 1 · install
npm install @altask/sdk

// 2 · authenticate
import { Altask } from "@altask/sdk";
const client = new Altask({ token: process.env.ALTASK_KEY });

// 3 · ship
await client.sites.deploy({ id: "site_8aL2k9X" });

# 1 · install
pip install altask

# 2 · authenticate
from altask import Altask
client = Altask(token=os.environ["ALTASK_KEY"])

# 3 · ship
client.sites.deploy(id="site_8aL2k9X")

# deploy a site
curl -X POST https://api.altask.dev/v1/sites/site_8aL2k9X/deploys \
  -H "Authorization: Bearer $ALTASK_KEY"

SDK install

Install the Altask SDK with your package manager of choice. The same client supports server, edge, and worker runtimes.

npm install @altask/sdk @altask/components

pnpm add @altask/sdk @altask/components

yarn add @altask/sdk @altask/components

bun add @altask/sdk @altask/components

Authentication

The Altask API uses Bearer tokens. Generate keys in Dashboard → Settings → API keys. Tokens scope to a single workspace and rotate on demand.

# every request
curl https://api.altask.dev/v1/me \
  -H "Authorization: Bearer $ALTASK_KEY"

# response
{
  "workspace": "acme",
  "plan": "pro",
  "scopes": ["sites:read", "sites:write"]
}

The Hero is the headline-and-CTA block at the top of most marketing pages. It accepts a title, subtitle, and call-to-action; switch variant for a centered or split layout.

import { Hero } from "@altask/components";

export default function Page() {
  return (
    <Hero
      title="Build websites visually"
      subtitle="No code. Full control."
      cta={{ label: "Start free", href: "/editor" }}
      variant="centered"
    />
  );
}

Render a pricing table with monthly/yearly toggle, feature lists, and an optional highlighted plan. Plans are passed as an array; the order on the page matches the order in the array.

<Pricing
  plans={[
    { id: "free", name: "Free",  price: 0,  features: ["1 site"] },
    { id: "pro",  name: "Pro",   price: 19, features: ["Unlimited sites"] },
    { id: "team", name: "Team",  price: 59, features: ["Roles & SSO"] }
  ]}
  highlight="pro"
/>

A composable form with built-in validation, server-action support, and accessible labels. Use the fields prop for quick declarative forms or compose <Form.Field/> children for full control.

<Form
  fields={[
    { name: "email", type: "email", label: "Email", required: true },
    { name: "company", type: "text", label: "Company" }
  ]}
  action={subscribe}
  submitLabel="Subscribe"
/>

Render the site footer with brand, navigation columns, and a legal/social row. Columns are passed as plain objects so you can drive them from a CMS.

Create, list, update, and delete sites. Every site has at least one page and one deploy.

• POST /v1/sites Create a site
• GET /v1/sites List all sites
• GET /v1/sites/{id} Retrieve a site
• PATCH /v1/sites/{id} Update a site
• DEL /v1/sites/{id} Archive a site

Create a site

# request
curl -X POST https://api.altask.dev/v1/sites \
  -H "Authorization: Bearer $ALTASK_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "habits-app", "template": "lift"}'

# response · 201
{
  "id": "site_8aL2k9X",
  "name": "habits-app",
  "url": "https://habits-app.altask.dev",
  "publish_token": "pt_••••••••",
  "created_at": "2026-09-14T18:42:00Z"
}

Pages live inside a site. Each page has a slug, a JSON content tree, and an SEO block. Updates are atomic — partial PATCH bodies are merged server-side.

• GET/v1/sites/{id}/pagesList pages
• POST/v1/sites/{id}/pagesCreate a page
• GET/v1/pages/{id}Retrieve a page
• PATCH/v1/pages/{id}Update slug, blocks, or SEO
• DEL/v1/pages/{id}Archive a page

Update SEO meta

curl -X PATCH https://api.altask.dev/v1/pages/page_4Bz1 \
  -H "Authorization: Bearer $ALTASK_KEY" \
  -H "Content-Type: application/json" \
  -d '{"seo": {"title": "Pricing — Altask", "description": "Plans for every team."}}'

Each deploy is an immutable snapshot of a site. Deploys are queued, built, and promoted to the global edge. Use state to track progress; promote previews to production with a single PATCH.

• POST/v1/sites/{id}/deploysTrigger a deploy
• GET/v1/sites/{id}/deploysList recent deploys
• GET/v1/deploys/{id}Inspect a deploy
• PATCH/v1/deploys/{id}Promote to production

Webhooks

Subscribe to lifecycle events to keep your CMS, CI, or analytics in sync. Payloads are signed with HMAC-SHA256 — verify with the X-Altask-Signature header.

Embed snippet

Drop a single script tag into any HTML page to render an Altask block in place. Snippets render server-side at the edge and hydrate progressively.

<div id="altask-pricing"></div>
<script
  src="https://embed.altask.dev/v1/altask.js"
  data-block="pricing"
  data-site="site_8aL2k9X"
  data-mount="#altask-pricing"
  defer
></script>

Error reference

Errors return a JSON body with code, message, and an optional request_id. Always log request_id when contacting support — it pins the request to a single trace.

# example error
{
  "code": "invalid_request",
  "message": "slug must match ^[a-z0-9-]+$",
  "request_id": "req_3rWv0pY",
  "errors": [
    { "path": "slug", "rule": "pattern" }
  ]
}

Pull content from any headless CMS and let editors update copy without touching layout. The block tree stays in Altask, the strings live in the CMS.

1. Map fields. In the editor, mark text props as bound and pick a CMS path (e.g. hero.title).
2. Add a fetch hook. Server-side, fetch your CMS, then pass the JSON to client.pages.render({ id, data }).
3. Subscribe. Listen for the page.published webhook to revalidate caches in your CMS layer.

const data = await fetchCms("home");
const html = await client.pages.render({
  id: "page_4Bz1",
  data
});

Apex domains, subdomains, and wildcards. Add a CNAME, hit verify, done. We handle DNSSEC, CAA, and edge propagation automatically.

# verify a domain after DNS update
curl -X POST https://api.altask.dev/v1/sites/site_8aL2k9X/domains/verify \
  -H "Authorization: Bearer $ALTASK_KEY" \
  -d '{"hostname": "habits-app.com"}'

The Altask CLI runs the same build pipeline as the cloud — preview locally, lint your blocks, and ship from CI without leaving your terminal.

npx @altask/cli login
npx @altask/cli dev      # preview at localhost:3010
npx @altask/cli build    # static export to ./dist

# .github/workflows/deploy.yml
- name: Deploy
  run: |
    npm i -g @altask/cli
    altask deploy --site $SITE_ID --token ${{ secrets.ALTASK_KEY }}