# Highlight Docs

> Highlight is a platform for creating, selling, and managing on-chain digital collectibles. These docs cover the no-code creator dashboard, the TypeScript SDK (`@highlightxyz/sdk`), and the REST API (`https://api.highlightv2.xyz`). Every collection type, sale type, and access mode is documented with the exact combinations the platform supports.

The full concatenated documentation is at [llms-full.txt](/llms-full.txt).

## Core entrypoints

- [Introduction](https://docs.highlightv2.xyz/getting-started/introduction/): what Highlight is and who it's for
- [Developer quick start](https://docs.highlightv2.xyz/getting-started/developer-quick-start/): install SDK, authenticate, first call
- [Mint an NFT end-to-end](https://docs.highlightv2.xyz/guides/developer/mint-first-nft/): the full developer pipeline
- [Support matrix](https://docs.highlightv2.xyz/reference/support-matrix/): every valid collection + sale + access combination
- [Authentication](https://docs.highlightv2.xyz/reference/auth/): SIWE, Privy, and API keys
- [Errors](https://docs.highlightv2.xyz/reference/errors/): every typed error and its HTTP status
- [Glossary](https://docs.highlightv2.xyz/reference/glossary/): vocabulary used across the platform

## Getting started

- [Developer quick start](https://docs.highlightv2.xyz/getting-started/developer-quick-start/): Install @highlightxyz/sdk, authenticate, and make your first API call in under 5 minutes.
- [Introduction](https://docs.highlightv2.xyz/getting-started/introduction/): What Highlight is, who it's for, and what you can build with it.
- [Creator quick start](https://docs.highlightv2.xyz/getting-started/quick-start/): Launch your first Highlight collection from the dashboard in under 10 minutes.

## Concepts

- [Collections](https://docs.highlightv2.xyz/concepts/collections/): The top-level unit of Highlight — what a collection is and the five types you can create.
- [Contracts](https://docs.highlightv2.xyz/concepts/contracts/): Every collection is backed by a smart contract. The platform picks the implementation automatically from the collection type and token standard.
- [Editions](https://docs.highlightv2.xyz/concepts/editions/): Open editions, limited editions, and 1/1s — single-artwork collections with different supply models.
- [Gates](https://docs.highlightv2.xyz/concepts/gates/): Access control for sales — allowlists, token gating, and other conditions.
- [Generative Art](https://docs.highlightv2.xyz/concepts/generative-art/): Code-based collections where artwork is generated programmatically at mint time.
- [Mechanics](https://docs.highlightv2.xyz/concepts/mechanics/): The on-chain engines behind each sale type. Built-in mechanics cover fixed price, Dutch, ranked, and gasless; custom mechanics let you plug in your own.
- [Media & Storage](https://docs.highlightv2.xyz/concepts/media-and-storage/): Uploading assets, file types, and decentralized storage with Arweave.
- [Sale Types](https://docs.highlightv2.xyz/concepts/sale-types/): Fixed price, Dutch auction, and ranked auction — how each sale type works.
- [Sales](https://docs.highlightv2.xyz/concepts/sales/): How sales work on Highlight — lifecycle, access modes, configuration, and the rules for adding sales to draft vs live collections.
- [Series](https://docs.highlightv2.xyz/concepts/series/): Multi-token collections where each token has unique metadata. Two variants — Collectors Choice (collectors pick tokens) and Standard (sequential or random).
- [Tokens & Metadata](https://docs.highlightv2.xyz/concepts/tokens-and-metadata/): Token structure, attributes, and how metadata works across collection types.

## Creator guides

- [Configuring Sales](https://docs.highlightv2.xyz/guides/creator/configuring-sales/): Set up pricing, scheduling, gas sponsorship, and payment recipients for your sales.
- [Creating a Collection](https://docs.highlightv2.xyz/guides/creator/creating-a-collection/): Step-by-step walkthrough of the collection creation wizard.
- [Deploying a Contract](https://docs.highlightv2.xyz/guides/creator/deploying-a-contract/): Deploy your collection's smart contract on-chain.
- [Managing Collections](https://docs.highlightv2.xyz/guides/creator/managing-collections/): Edit, configure, and monitor your live collections.
- [Minting Experience](https://docs.highlightv2.xyz/guides/creator/minting-experience/): What collectors see when they visit your mint page.
- [Setting Up Gates](https://docs.highlightv2.xyz/guides/creator/setting-up-gates/): Create and configure access control gates for your sales.

## Developer guides

- [Deploy workflow](https://docs.highlightv2.xyz/guides/developer/deploy-workflow/): The multi-step state machine that takes a draft collection to Live — with the complete polling pattern.
- [Gated sales](https://docs.highlightv2.xyz/guides/developer/gated-sales/): Restrict who can mint using allowlists, token ownership, or on-chain conditions — with the complete claim flow.
- [Media upload flow](https://docs.highlightv2.xyz/guides/developer/media-upload/): The three-step upload handshake — create session, PUT bytes, poll for Ready. Covers Files and Directories (zips).
- [Mint an NFT end-to-end](https://docs.highlightv2.xyz/guides/developer/mint-first-nft/): The full developer flow — sign in, create a draft, upload art, deploy the contract, configure a sale, let a collector mint.
- [Ranked auctions](https://docs.highlightv2.xyz/guides/developer/ranked-auctions/): Sealed-bid, on-chain ranked auctions — configure, take bids, settle, and claim.

## SDK

- [Clients overview](https://docs.highlightv2.xyz/sdk/clients/): Every sub-client on the HighlightClient — what it's for and where to learn more.
- [Collections](https://docs.highlightv2.xyz/sdk/collections/): Create, list, and manage collections via the SDK. The client.collection sub-client covers the full collection lifecycle plus its sales and deploy workflow.
- [Config](https://docs.highlightv2.xyz/sdk/config/): Read supported chains and system contract addresses. Both endpoints are public.
- [Contracts](https://docs.highlightv2.xyz/sdk/contracts/): Read contract records with client.contract. Deploy operations live on client.collection.
- [Gates](https://docs.highlightv2.xyz/sdk/gates/): Create, update, and delete access control gates with client.gate.
- [Mechanics](https://docs.highlightv2.xyz/sdk/mechanics/): Discover built-in sale mechanics and register custom ones with client.mechanic.
- [Media](https://docs.highlightv2.xyz/sdk/media/): Upload, process, archive, and enumerate media assets with client.media.
- [Sales](https://docs.highlightv2.xyz/sdk/sales/): Configure sales, build claim and bid transactions via client.collection's sale methods.
- [SDK setup](https://docs.highlightv2.xyz/sdk/setup/): Install, configure, and use @highlightxyz/sdk against api.highlightv2.xyz.
- [Tokens](https://docs.highlightv2.xyz/sdk/tokens/): Read minted tokens from a collection. client.token exposes list and get — token records are created by the indexer, not by callers.

## Reference

- [Authentication](https://docs.highlightv2.xyz/reference/auth/): SIWE, Privy, and API keys — every way to authenticate against the Highlight API.
- [Errors](https://docs.highlightv2.xyz/reference/errors/): Every typed error the Highlight API can raise, mapped to its HTTP status and feature.
- [Glossary](https://docs.highlightv2.xyz/reference/glossary/): Vocabulary used across the Highlight platform, SDK, and docs.
- [Support matrix](https://docs.highlightv2.xyz/reference/support-matrix/): Exactly which combinations of collection type, sale type, and access mode Highlight supports. Anything not on this matrix is rejected.