Skip to content
Highlight Docs
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Getting Started
Introduction
Creator quick start
Developer quick start
Concepts
Collections
Editions
Series
Generative
Contracts
Sales
Sale types
Gates
Mechanics
Media & storage
Tokens & metadata
Creator guides
Creating a collection
Configuring sales
Setting up gates
Deploying a contract
Managing collections
Minting experience
Developer guides
Mint an NFT end-to-end
Deploy workflow
Media upload flow
Gated sales
Ranked auctions
SDK
Setup
Clients overview
Collections
Sales
Gates
Media
Mechanics
Tokens
Contracts
Config
REST API
Overview
Operations
List collections
GET
Create collection
POST
Trending collections
GET
Featured collections
GET
Get collection
GET
List series previews
GET
Finalize collection base URI to Arweave
POST
Update generative draft details
PATCH
Update series draft details
PATCH
Update edition details
PATCH
Get collection sales
GET
Add a sale to a collection
POST
Delete a sale
DELETE
Update a sale
PATCH
Claim collection sale
POST
Bid on an auction sale
POST
Reclaim a non-winning ranked-auction bid
POST
Withdraw ranked-auction earnings
POST
Get ranked-auction live standings
GET
Fulfill (settle) an English auction
POST
Cancel an English auction
POST
Get English auction standings
GET
Get English auction bid history
GET
Initiate collection deployment
POST
Get deployment status
GET
Cancel a deployment
POST
List tokens
GET
List token attribute facets
GET
Get token
GET
List chains
GET
Get system contract
GET
List contracts
GET
Get contract
GET
List gates
GET
Create gate
POST
Get gate
GET
Delete gate
DELETE
Update gate
PATCH
Preview a collection
GET
Preview collection attributes
GET
Preview collection tokens
GET
Preview a token
GET
Preview a currency
GET
Preview a Farcaster user
GET
postIndexerChainsByChainIdActivate
POST
postIndexerChainsByChainIdReset
POST
postIndexerChainsByChainIdPoll
POST
List mechanics
GET
Create mechanic
POST
Get mechanic
GET
Update mechanic
PATCH
Add mechanic deployment
POST
Remove mechanic deployment
DELETE
Create media upload session
POST
Upload media bytes
PUT
Process a media asset
POST
List children of a Directory media asset
GET
Get media asset
GET
Delete a media asset
DELETE
Publish media to archive
POST
Get a child File Entity by path
GET
Get transaction finalization status
GET
Submit a transaction for tracking
POST
Issue a SIWE nonce
POST
Sign in user
POST
List API keys
GET
Create API key
POST
Revoke API key
DELETE
Health check
GET
Reference
Authentication
Errors
Support matrix
Glossary
Select theme
Dark
Light
Auto
Health check
GET
/health
Check if the service is healthy.
Responses
Section titled “ Responses ”
200
Section titled “200 ”
Service health status
Select media type
application/json
object
status
required
string
Allowed value:
healthy