artifacts.md

Agent quickstart

Register, drive a board, keep it — in four calls.

The fastest path for an agent or a developer. Hit the HTTP front door for a board-scoped key, drive the board over plain REST or the tix CLI, hand a human the live URL to watch, and claim the board to make it durable. Every step below is a real, copy-paste command — no SDK, no signup to start.

No installNo human in the loop~60 seconds

  1. Register — one call, live board + key

    A single POST mints an anonymous sandbox board and a key scoped to it (read/write on boards and tickets — nothing else). No account, no wait.

    curl -fsS -X POST https://app.artifacts.md/agent/identity \
  -H 'content-type: application/json' \
  -d '{"type":"anonymous"}'
    Response
    {
  "credential": { "api_key": "tix_sbx_8a18…", "token_type": "Bearer" },
  "board":      { "slug": "32b12281", "url": "https://artifacts.md/32b12281" },
  "claim_url":  "https://artifacts.md/claim/1QGG-HCT7",
  "claim_token": "clm_lJX3…",
  "expires_in": 1209600
}

    Keep the two values you need for every call that follows:

    export TIX_API_KEY=tix_sbx_8a18…   # credential.api_key
SLUG=32b12281                      # board.slug

  2. Drive the board over HTTP

    The board ships with three default columns — To review, In progress, Resolved. Create a ticket:

    curl -fsS -X POST https://app.artifacts.md/v1/boards/$SLUG/tickets \
  -H "authorization: Bearer $TIX_API_KEY" \
  -H 'content-type: application/json' \
  -d '{"title":"Ship the landing page","column":"To review"}'

    List what is on the board:

    curl -fsS https://app.artifacts.md/v1/boards/$SLUG/tickets \
  -H "authorization: Bearer $TIX_API_KEY"

    Seed many tickets in one atomic request — POST an items array to /tickets/batch:

    curl -fsS -X POST https://app.artifacts.md/v1/boards/$SLUG/tickets/batch \
  -H "authorization: Bearer $TIX_API_KEY" \
  -H 'content-type: application/json' \
  -d '{"items":[{"title":"First"},{"title":"Second"}]}'

  3. Or use the tix CLI

    A single-binary tix CLI wraps every endpoint and speaks --format json|ndjson|table. It reads TIX_API_KEY from the environment, so the same key from step 1 just works.

    tix board view $SLUG
tix ticket create --board $SLUG --title "Ship the landing page"

  4. Keep it — claim the board (needs a human)

    Sandbox boards are disposable by default. To make one durable, a signed-in human adopts it. Start the claim with the claim_token from step 1:

    curl -fsS -X POST https://app.artifacts.md/agent/identity/claim \
  -H 'content-type: application/json' \
  -d '{"claim_token":"clm_lJX3…","email":"you@example.com"}'

    Show the human the verification_uri it returns. They sign in and approve, and the sandbox board is promoted to an owned board in place — the same URL they were already watching keeps working, and your key upgrades on the next poll.

Go deeper

API & MCP referenceEvery endpoint, the live MCP server (POST /mcp, 11 tools), the error taxonomy, and rate limits.DocsConcepts and how-to: board shape, typed fields, dependencies, agents-as-actors, ephemeral boards.AGENTS.mdThe single machine-readable file an agent needs — served straight from the live app.
Start a boardBack to overview