Seedling

GET/api/v1/seedling/daily/{generator_id}

Daily_seed

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

generator_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/seedling/daily/string"

{  "date": "string",  "generator_id": "string",  "seed": "string",  "version": 0}

POST/api/v1/seedling/generate

Generate

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

generator_id*string

Generator id to execute

params?unknown

Generation parameters

seed*string

Seed string driving the deterministic output

version?|

Optional version pin; omit to use the latest published version (echoed back)

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/seedling/generate" \  -H "Content-Type: application/json" \  -d '{    "generator_id": "string",    "seed": "string"  }'

{  "cached": true,  "content_hash": "string",  "generator_id": "string",  "output": null,  "permalink": "string",  "png_url": "string",  "seed": "string",  "version": 0}

POST/api/v1/seedling/generate/batch

Generate_batch

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

base_seed?|

Base seed for deterministically-derived sub-seeds

count?|

Number of sub-seeds to derive from base_seed

Formatint32

Range0 <= value

generator_id*string

Generator id to execute

params?unknown

Generation parameters applied to every seed

seeds?array<string>|

Explicit list of seeds, or omit and supply base_seed + count

version?|

Optional version pin

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/seedling/generate/batch" \  -H "Content-Type: application/json" \  -d '{    "generator_id": "string"  }'

{  "count": 0,  "results": [    {      "cached": true,      "content_hash": "string",      "generator_id": "string",      "output": null,      "permalink": "string",      "png_url": "string",      "seed": "string",      "version": 0    }  ]}

GET/api/v1/seedling/generators

List_generators

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

q?string

Full-text search query applied to generator name

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Page size

Formatint64

Range0 <= value

sort_by?string

Sort field

sort_order?string

Sort order (asc or desc)

Value in

"asc"
"desc"

filter?array<string>

Additional filter expressions in the form field:operator:value

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/seedling/generators"

{  "generators": [    {      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "determinism_contract": "string",      "generator_type": "name",      "id": "string",      "name": "string",      "params_schema": null,      "status": "draft",      "updated_at": "2019-08-24T14:15:22Z",      "version": 0    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/seedling/generators

Create_generator

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

daily_salt?|

Per-generator daily salt for daily-challenge seeds

determinism_contract?|

Determinism contract documentation

generator_type*GeneratorType

Generator algorithm family

Value in

"name"
"loot"
"sequence"
"noise"
"grid_map"
"bsp_rooms"
"wfc"
"perlin_noise"
"simplex_noise"
"grammar"

grammar?unknown

Custom grammar/constraint definition (required for grammar generators)

name*string

Human-readable generator name

params_schema?unknown

JSON Schema describing accepted params

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/seedling/generators" \  -H "Content-Type: application/json" \  -d '{    "generator_type": "name",    "name": "string"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "determinism_contract": "string",  "generator_type": "name",  "id": "string",  "name": "string",  "params_schema": null,  "status": "draft",  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

GET/api/v1/seedling/generators/{generator_id}

Get_generator

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

generator_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/seedling/generators/string"

{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "determinism_contract": "string",  "generator_type": "name",  "id": "string",  "name": "string",  "params_schema": null,  "status": "draft",  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

POST/api/v1/seedling/generators/{generator_id}/publish

Publish_generator

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

generator_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

version?|

Explicit version to freeze; omit to use the generator's current version. The version is honored: it becomes the immutable snapshot's version.

Formatint32

Range0 <= value

Defaultnull

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/seedling/generators/string/publish" \  -H "Content-Type: application/json" \  -d '{}'

{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "determinism_contract": "string",  "generator_type": "name",  "id": "string",  "name": "string",  "params_schema": null,  "status": "draft",  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

GET/api/v1/seedling/generators/{generator_id}/versions/{version}

Get_version

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

generator_id*string

version*integer

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/seedling/generators/string/versions/0"

{  "determinism_contract": "string",  "generator_id": "string",  "generator_type": "name",  "grammar": null,  "params_schema": null,  "published_at": "2019-08-24T14:15:22Z",  "published_by": "string",  "version": 0}

GET/api/v1/seedling/generators/{generator_id}/v{version}/{seed}

Permalink

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

generator_id*string

version*integer

Formatint32

Range0 <= value

seed*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/seedling/generators/string/v0/string"

{  "cached": true,  "content_hash": "string",  "generator_id": "string",  "output": null,  "permalink": "string",  "png_url": "string",  "seed": "string",  "version": 0}

GET/api/v1/seedling/seeds

List_seeds

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

q?string

Full-text search query applied to seed name

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Page size

Formatint64

Range0 <= value

featured_only?boolean

Only return featured seeds

filter?array<string>

Additional filter expressions in the form field:operator:value

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/seedling/seeds"

{  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  },  "seeds": [    {      "created_at": "2019-08-24T14:15:22Z",      "featured": true,      "generator_id": "string",      "id": "string",      "name": "string",      "published_by": "string",      "seed": "string",      "tags": [        "string"      ],      "version": 0    }  ]}

POST/api/v1/seedling/seeds

Publish_seed

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

generator_id*string

Generator id the seed targets

name*string

Display name for the seed registry

seed*string

Seed string

tags?array<string>

Tags for discovery

version*integer

Generator version

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/seedling/seeds" \  -H "Content-Type: application/json" \  -d '{    "generator_id": "string",    "name": "string",    "seed": "string",    "version": 0  }'

{  "created_at": "2019-08-24T14:15:22Z",  "featured": true,  "generator_id": "string",  "id": "string",  "name": "string",  "published_by": "string",  "seed": "string",  "tags": [    "string"  ],  "version": 0}

POST/api/v1/seedling/seeds/{seed_id}/feature

Feature_seed

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

seed_id*string

Named seed id

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/seedling/seeds/string/feature"

{  "created_at": "2019-08-24T14:15:22Z",  "featured": true,  "generator_id": "string",  "id": "string",  "name": "string",  "published_by": "string",  "seed": "string",  "tags": [    "string"  ],  "version": 0}

POST/api/v1/seedling/verify-determinism

Verify_determinism

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

generator_id*string

Generator id to re-derive

params?unknown

Generation parameters

seed*string

Seed driving the deterministic output

version*integer

Version pin to verify

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/seedling/verify-determinism" \  -H "Content-Type: application/json" \  -d '{    "generator_id": "string",    "seed": "string",    "version": 0  }'

{  "deterministic": true,  "generator_id": "string",  "seed": "string",  "version": 0}

GET/api/v1/seedling/{domain}/artifacts/{artifact_id}/derived

Derived

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

artifact_id*string

Query Parameters

depth?integer

Maximum derivation depth to traverse

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/seedling/string/artifacts/string/derived"

{  "artifacts": [    {      "chain_length": 0,      "created_at": "2019-08-24T14:15:22Z",      "current_owner": {        "id": "string",        "kind": "string"      },      "domain": "string",      "external_ref": null,      "head_hash": "string",      "head_record_id": "string",      "id": "string",      "serial": 0,      "serial_display": "string",      "series_id": "string",      "status": "active"    }  ],  "count": 0}

GET/api/v1/seedling/{domain}/artifacts/{artifact_id}/history

History

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

artifact_id*string

Query Parameters

verify?string

Verification mode: chain re-verifies the hash chain, genesis also re-runs the seed triple

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/seedling/string/artifacts/string/history"

{  "artifact": {    "chain_length": 0,    "created_at": "2019-08-24T14:15:22Z",    "current_owner": {      "id": "string",      "kind": "string"    },    "domain": "string",    "external_ref": null,    "head_hash": "string",    "head_record_id": "string",    "id": "string",    "serial": 0,    "serial_display": "string",    "series_id": "string",    "status": "active"  },  "chain_valid": true,  "first_broken_sequence": 0,  "genesis_verified": true,  "records": [    {      "actor": {        "id": "string",        "kind": "string"      },      "artifact_id": "string",      "citation": null,      "from_owner": null,      "hash": "string",      "id": "string",      "inputs": [        "string"      ],      "kind": "genesis",      "payload": null,      "prev_hash": "string",      "recorded_at": "2019-08-24T14:15:22Z",      "reference": null,      "sequence": 0,      "to_owner": null    }  ]}

POST/api/v1/seedling/{domain}/artifacts/{artifact_id}/records

Append_record

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

artifact_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

inputs?array<string>

Input artifact ids for transformation records

kind*RecordKind

Record kind to append

Value in

"genesis"
"transfer"
"transformation"
"attestation"
"retirement"

payload?unknown

Arbitrary record payload

reference?null|

to_owner?null|

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/seedling/string/artifacts/string/records" \  -H "Content-Type: application/json" \  -d '{    "kind": "genesis"  }'

{  "actor": {    "id": "string",    "kind": "string"  },  "artifact_id": "string",  "citation": null,  "from_owner": null,  "hash": "string",  "id": "string",  "inputs": [    "string"  ],  "kind": "genesis",  "payload": null,  "prev_hash": "string",  "recorded_at": "2019-08-24T14:15:22Z",  "reference": null,  "sequence": 0,  "to_owner": null}

GET/api/v1/seedling/{domain}/owners/{principal}/artifacts

Owned

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

principal*string

Query Parameters

ever?boolean

Return everything ever held instead of only current holdings

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/seedling/string/owners/string/artifacts"

{  "artifacts": [    {      "chain_length": 0,      "created_at": "2019-08-24T14:15:22Z",      "current_owner": {        "id": "string",        "kind": "string"      },      "domain": "string",      "external_ref": null,      "head_hash": "string",      "head_record_id": "string",      "id": "string",      "serial": 0,      "serial_display": "string",      "series_id": "string",      "status": "active"    }  ],  "count": 0}

POST/api/v1/seedling/{domain}/series

Create_series

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

allowed_minters?AllowedMinters

Who may mint from this series

Value in

"admin_only"
"any_authenticated"
"service"

genesis_generator?null|

max_supply*integer

Maximum mintable supply

Formatint64

Range0 <= value

metadata?unknown

Arbitrary series metadata

name*string

Display name of the series

per_user_limit?|

Per-user mint limit

Formatint64

Range0 <= value

serial_assignment?SerialAssignment

Serial assignment strategy

Value in

"sequential"
"random"

window?

Mint window bounds

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/seedling/string/series" \  -H "Content-Type: application/json" \  -d '{    "max_supply": 0,    "name": "string"  }'

{  "allowed_minters": "admin_only",  "circulating": 0,  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "domain": "string",  "genesis_generator": null,  "id": "string",  "max_supply": 0,  "metadata": null,  "minted": 0,  "name": "string",  "per_user_limit": 0,  "retired": 0,  "serial_assignment": "sequential",  "window": {    "closes_at": "2019-08-24T14:15:22Z",    "opens_at": "2019-08-24T14:15:22Z"  }}

GET/api/v1/seedling/{domain}/series/{series_id}

Get_series

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

series_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/seedling/string/series/string"

{  "allowed_minters": "admin_only",  "circulating": 0,  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "domain": "string",  "genesis_generator": null,  "id": "string",  "max_supply": 0,  "metadata": null,  "minted": 0,  "name": "string",  "per_user_limit": 0,  "retired": 0,  "serial_assignment": "sequential",  "window": {    "closes_at": "2019-08-24T14:15:22Z",    "opens_at": "2019-08-24T14:15:22Z"  }}

POST/api/v1/seedling/{domain}/series/{series_id}/mint

Mint

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

series_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

for_owner?null|

idempotency_key*string

Idempotency key guaranteeing exactly-once minting

inputs?array<string>

Input artifact ids consumed at genesis

reference?null|

seed?|

Seed for generator-pinned series genesis

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/seedling/string/series/string/mint" \  -H "Content-Type: application/json" \  -d '{    "idempotency_key": "string"  }'

{  "artifact": {    "chain_length": 0,    "created_at": "2019-08-24T14:15:22Z",    "current_owner": {      "id": "string",      "kind": "string"    },    "domain": "string",    "external_ref": null,    "head_hash": "string",    "head_record_id": "string",    "id": "string",    "serial": 0,    "serial_display": "string",    "series_id": "string",    "status": "active"  },  "genesis_record": {    "actor": {      "id": "string",      "kind": "string"    },    "artifact_id": "string",    "citation": null,    "from_owner": null,    "hash": "string",    "id": "string",    "inputs": [      "string"    ],    "kind": "genesis",    "payload": null,    "prev_hash": "string",    "recorded_at": "2019-08-24T14:15:22Z",    "reference": null,    "sequence": 0,    "to_owner": null  },  "replayed": true}

POST/api/v1/seedling/{domain}/track

Track

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

external_ref*

External reference to the tracked object

owner?null|

payload?unknown

Genesis attestation payload

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/seedling/string/track" \  -H "Content-Type: application/json" \  -d '{    "external_ref": {      "id": "string",      "service": "string"    }  }'

{  "artifact": {    "chain_length": 0,    "created_at": "2019-08-24T14:15:22Z",    "current_owner": {      "id": "string",      "kind": "string"    },    "domain": "string",    "external_ref": null,    "head_hash": "string",    "head_record_id": "string",    "id": "string",    "serial": 0,    "serial_display": "string",    "series_id": "string",    "status": "active"  },  "genesis_record": {    "actor": {      "id": "string",      "kind": "string"    },    "artifact_id": "string",    "citation": null,    "from_owner": null,    "hash": "string",    "id": "string",    "inputs": [      "string"    ],    "kind": "genesis",    "payload": null,    "prev_hash": "string",    "recorded_at": "2019-08-24T14:15:22Z",    "reference": null,    "sequence": 0,    "to_owner": null  },  "replayed": true}

Seedling

200application/json

404

200application/json

400

404

200application/json

400

200application/json

201application/json

400

403

200application/json

404

200application/json

403

404

409

200application/json

404

200application/json

404

200application/json

201application/json

400

404

200application/json

403

200application/json

404

200application/json

200application/json

404

201application/json

403

404

409

200application/json

201application/json

400

403

200application/json

404

201application/json

400

403

409

201application/json

400

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`