Create collection

POST

/collection

Create a draft collection and bind it to an existing or new draft contract.

Authorizations

• bearerAuth

Request Body ^required

object

name

required

string

>= 1 characters

description

required

string

>= 1 characters

contractId

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

contract

object

chainId

required

integer

> 0 <= 9007199254740991

name

required

string

>= 1 characters

symbol

required

string

>= 1 characters

standard

required

string

Allowed values: ERC721 ERC1155

logoMediaId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

image

required

string format: uri

type

required

string

Allowed values: OpenEdition LimitedEdition OneOfOne Series GenerativeSeries

royalty

object

address

required

string

>= 1 characters

amount

required

integer

<= 10000

tokenManager

string

>= 1 characters

Responses

200

Created collection

object

highlightId

required

string

collectionId

required

Any of:

string

string

null

null

name

required

string

description

required

Any of:

string

string

null

null

logoMediaId

required

string

baseUriId

required

Any of:

string

string

null

null

royaltyAddress

required

Any of:

string

string

null

null

royaltyAmount

required

Any of:

integer

integer

>= -9007199254740991 <= 9007199254740991

null

null

tokenManager

required

Any of:

string

string

null

null

status

required

string

Allowed values: Draft InProgress Live Migrated Disabled

type

required

string

Allowed values: OpenEdition LimitedEdition OneOfOne Series GenerativeSeries

contract

required

object

id

required

string

chainId

required

integer

>= -9007199254740991 <= 9007199254740991

type

required

string

Allowed values: GenerativeSeries Series MultipleEditions MultipleEditionsDFS SingleEdition SingleEditionDFS EditionsDFS1155

standard

required

string

Allowed values: ERC721 ERC1155

creatorAddress

required

string

name

required

string

address

required

Any of:

string

string

null

null

symbol

required

string

contractUri

required

Any of:

string

string

null

null

status

required

string

Allowed values: Draft Deploying Live

createdAt

required

string

updatedAt

required

string

createdAt

required

string

updatedAt

required

string

archivedAt

required

Any of:

string

string

null

null

hidden

required

Any of:

boolean

boolean

null

null

disabled

required

Any of:

boolean

boolean

null

null

series

required

Any of:

object

object

size

required

integer

<= 9007199254740991

isCollectorsChoice

boolean

assetsMediaId

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

null

null

generative

required

Any of:

object

object

size

required

integer

<= 9007199254740991

codeMediaId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

isCurated

boolean

isGpuRendering

boolean

editionType

string

Allowed values: Limited Open

allowedHashes

Array<string>

requiredParams

Array<string>

captureSettings

object

trigger

required

string

Allowed values: Function Delay

delay

integer

> 0 <= 9007199254740991

selector

string

>= 1 characters

selectorType

string

Allowed values: SVG ELEMENT

viewPortHeight

integer

> 0 <= 9007199254740991

viewPortWidth

integer

> 0 <= 9007199254740991

null

null

edition

required

Any of:

object

object

size

required

integer

<= 9007199254740991

name

string

>= 1 characters

description

string

>= 1 characters

imageMediaId

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

animationMediaId

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

imageMedia

Any of:

object

object

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

accountId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

kind

required

string

Allowed values: File Directory

scope

required

string

Allowed values: Collection User

provenance

required

string

Allowed values: UserUpload SystemGenerated

status

required

string

Allowed values: Pending Processing Ready Failed

fileName

required

string

mimeType

required

Any of:

string

string

null

null

fileSize

required

Any of:

integer

integer

<= 9007199254740991

null

null

contentHash

required

Any of:

string

string

null

null

parentId

required

Any of:

string

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

null

null

path

required

Any of:

string

string

null

null

uploadedAt

required

Any of:

string

string

null

null

locations

required

Array<object>

object

id

required

string

mediaId

required

string

provider

required

string

Allowed values: R2 Arweave S3 IPFS

role

required

string

Allowed values: Origin Archive Mirror

reference

required

string

status

required

string

Allowed values: Pending Succeeded Failed

attempts

required

integer

<= 9007199254740991

lastError

required

Any of:

string

string

null

null

syncedAt

required

Any of:

string

string

null

null

metadata

required

Any of:

object

object

key

additional properties

null

null

createdAt

required

string

updatedAt

required

string

url

required

Any of:

string

string format: uri

null

null

createdAt

required

string

updatedAt

required

string

null

null

animationMedia

Any of:

object

object

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

accountId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

kind

required

string

Allowed values: File Directory

scope

required

string

Allowed values: Collection User

provenance

required

string

Allowed values: UserUpload SystemGenerated

status

required

string

Allowed values: Pending Processing Ready Failed

fileName

required

string

mimeType

required

Any of:

string

string

null

null

fileSize

required

Any of:

integer

integer

<= 9007199254740991

null

null

contentHash

required

Any of:

string

string

null

null

parentId

required

Any of:

string

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

null

null

path

required

Any of:

string

string

null

null

uploadedAt

required

Any of:

string

string

null

null

locations

required

Array<object>

object

id

required

string

mediaId

required

string

provider

required

string

Allowed values: R2 Arweave S3 IPFS

role

required

string

Allowed values: Origin Archive Mirror

reference

required

string

status

required

string

Allowed values: Pending Succeeded Failed

attempts

required

integer

<= 9007199254740991

lastError

required

Any of:

string

string

null

null

syncedAt

required

Any of:

string

string

null

null

metadata

required

Any of:

object

object

key

additional properties

null

null

createdAt

required

string

updatedAt

required

string

url

required

Any of:

string

string format: uri

null

null

createdAt

required

string

updatedAt

required

string

null

null

attributes

Array<object>

object

traitType

required

string

>= 1 characters

value

required

string

>= 1 characters

null

null

account

required

object

id

required

string

displayName

required

Any of:

string

string

null

null

primaryAddress

required

Any of:

string

string

null

null

ensName

required

Any of:

string

string

null

null

stats

required

Any of:

object

object

volume

required

string

volumeUsd

required

Any of:

string

string

null

null

ownerCount

required

integer

<= 9007199254740991

tokenCount

required

integer

<= 9007199254740991

updatedAt

required

string

null

null

sales

required

Array<object>

object

id

required

string

collectionId

required

string

name

required

Any of:

string

string

null

null

type

required

string

Allowed values: FIXED_PRICE DUTCH_AUCTION RANKED_AUCTION CUSTOM

startAt

required

string

endAt

required

Any of:

string

string

null

null

price

required

string

currency

required

string

maxPerTransaction

required

integer

>= -9007199254740991 <= 9007199254740991

maxPerWallet

required

integer

>= -9007199254740991 <= 9007199254740991

maxTotal

required

integer

>= -9007199254740991 <= 9007199254740991

paymentRecipient

required

string

accessMode

required

string

Allowed values: PUBLIC GATED

gateId

required

Any of:

string

string

null

null

gasSponsored

required

boolean

status

required

string

Allowed values: Draft Live

paused

required

boolean

mechanicId

required

Any of:

string

string

null

null

typeConfig

required

Any of:

unknown

null

null

vectorId

required

Any of:

string

string

null

null

customMintFee

required

Any of:

string

string

null

null

collectorMessage

required

Any of:

string

string

null

null

createdAt

required

string

updatedAt

required

string

400

Invalid request

401

Unauthorized

403

Forbidden

404

Not found