Skip to content
Highlight Docs

Highlight Docs

Highlight is a platform for creating and selling digital collectibles on-chain. Use the dashboard if you want to launch without writing code, or the TypeScript SDK if you’re building your own mint experience.

These docs have three paths. Pick yours.

For creators

Section titled “For creators”

You have a collection to launch and don’t want to think about contracts. Start in the dashboard.

  • Creator quick start — Your first collection, from wallet connect to live mint page.
  • Collection types — Editions, series, and generative — pick the right shape for your drop.
  • Sales & gates — Fixed price, Dutch auction, ranked auction, and who’s allowed to mint.
  • Creator guides — Step-by-step dashboard walkthroughs.

For developers

Section titled “For developers”

You’re building on top of Highlight — a custom mint page, an agent integration, or an automated drop pipeline. The SDK is the canonical path.

  • Developer quick start — Install the SDK, authenticate, make your first call.
  • Mint an NFT end-to-end — The full flow: auth → create → upload → deploy → sell → mint.
  • Deploy workflow — Drive the contract-deploy state machine from code.
  • REST API — Auto-generated from the OpenAPI spec. Every route, every shape, always in sync.
  • Error reference — Every typed error the backend can raise and what status code it maps to.

For AI agents

Section titled “For AI agents”

You’re an AI agent (or building one) that needs to act against Highlight. The SDK is typed end-to-end and every route has a stable error taxonomy — treat this as your tool surface.

  • llms.txt — Canonical index of this documentation, optimized for LLM ingestion.
  • llms-full.txt — Every concept, guide, and reference page concatenated into one file.
  • Support matrix — What combinations of collection type, sale type, and access mode are valid. The platform rejects everything not on the matrix.
  • Auth reference — SIWE, Privy, and API keys — machine-readable auth flows.

What Highlight does, in one screen

Section titled “What Highlight does, in one screen”
  • Collections — Editions (open / limited / 1-of-1), series (each token unique), or generative (code-generated at mint).
  • Contracts — Deployed to any supported chain. Contract type is derived from collection type.
  • Sales — Fixed price, Dutch auction, or ranked auction. Public (anyone) or gated (via a reusable gate).
  • Gates — Allowlist, token ownership, token attribute, currency balance, Farcaster follow. Combine with ALL or ANY.
  • Media — Upload once, reuse across tokens. R2-backed with optional Arweave archive.
  • Tokens — Minted NFTs with typed metadata, queryable by owner, attributes, or name.

The API URL is https://api.highlightv2.xyz. The SDK is @highlightxyz/sdk.