Lineage

POST/api/v1/lineage/breed

Breed

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

idempotency_key?|

Idempotency key to make the breeding request retry-safe

parents*array<string>

Parent entity ids

seed?|

Optional deterministic seed; if omitted, a server seed is committed

species_id*string

Species the parents belong to

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/lineage/breed" \  -H "Content-Type: application/json" \  -d '{    "parents": [      "string"    ],    "species_id": "string"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "mutations": [    "string"  ],  "offspring": [    {      "anchor_artifact_id": "string",      "anchor_hash": "string",      "entity_id": "string",      "generation": 0,      "inbreeding_coefficient": 0.1    }  ],  "parents": [    "string"  ],  "record_id": "string",  "requested_by": "string",  "seed": "string",  "species_id": "string",  "species_version": 0}

GET/api/v1/lineage/entities/{entity_id}/genome

Get_genome

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

entity_id*string

Query Parameters

full?boolean

Reveal hidden genes and raw alleles (admin only)

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/lineage/entities/string/genome"

{  "breeding_count": 0,  "entity_id": "string",  "expressed": {    "property1": "string",    "property2": "string"  },  "flags": [    "string"  ],  "generation": 0,  "numeric": {    "property1": 0.1,    "property2": 0.1  },  "owner": "string",  "raw_alleles": {    "property1": {      "first": "string",      "second": "string"    },    "property2": {      "first": "string",      "second": "string"    }  },  "species_id": "string"}

GET/api/v1/lineage/entities/{entity_id}/pedigree

Get_pedigree

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

entity_id*string

Query Parameters

depth?integer

Ancestry depth to traverse

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/lineage/entities/string/pedigree"

{  "ancestors": [    {      "distance": 0,      "entity_id": "string",      "generation": 0    }  ],  "entity_id": "string",  "generation": 0,  "inbreeding_coefficient": 0}

GET/api/v1/lineage/entities/{entity_id}/provenance

Get_provenance

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

entity_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/lineage/entities/string/provenance"

{  "anchor_artifact_id": "string",  "anchor_hash": "string",  "chain_verified": true,  "entity_id": "string",  "generation": 0,  "owner": "string",  "parents": [    "string"  ],  "record_id": "string",  "seed": "string",  "species_id": "string"}

POST/api/v1/lineage/genomes

Register_genome

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

alleles?

Diploid allele pairs keyed by trait id

entity_id*string

Entity id to register a founder genome for

flags?array<string>

Status flags (e.g. adult, healthy)

numeric?

Numeric trait values keyed by trait id

species_id*string

Species this genome belongs to

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/lineage/genomes" \  -H "Content-Type: application/json" \  -d '{    "entity_id": "string",    "species_id": "string"  }'

{  "breeding_count": 0,  "entity_id": "string",  "expressed": {    "property1": "string",    "property2": "string"  },  "flags": [    "string"  ],  "generation": 0,  "numeric": {    "property1": 0.1,    "property2": 0.1  },  "owner": "string",  "raw_alleles": {    "property1": {      "first": "string",      "second": "string"    },    "property2": {      "first": "string",      "second": "string"    }  },  "species_id": "string"}

POST/api/v1/lineage/preview

Preview

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

exact?boolean

Request exact odds (admin only); ignored for non-admins

parents*array<string>

Prospective parent entity ids

species_id*string

Species the prospective parents belong to

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/lineage/preview" \  -H "Content-Type: application/json" \  -d '{    "parents": [      "string"    ],    "species_id": "string"  }'

{  "exact": true,  "inbreeding_coefficient": 0,  "mutation_hint": "string",  "species_id": "string",  "traits": [    {      "band": "string",      "exact": {        "property1": 0.1,        "property2": 0.1      },      "trait_id": "string"    }  ]}

GET/api/v1/lineage/records

List_records

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

species_id?string

Filter by species id

parent?string

Filter by a parent entity id present in the breeding

requested_by?string

Filter by requester user id

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Page size

Formatint64

Range0 <= value

sort_order?string

Sort order (asc or desc)

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/lineage/records"

{  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  },  "records": [    {      "created_at": "2019-08-24T14:15:22Z",      "mutations": [        "string"      ],      "offspring": [        {          "anchor_artifact_id": "string",          "anchor_hash": "string",          "entity_id": "string",          "generation": 0,          "inbreeding_coefficient": 0.1        }      ],      "parents": [        "string"      ],      "record_id": "string",      "requested_by": "string",      "species_id": "string",      "species_version": 0    }  ]}

GET/api/v1/lineage/species

List_species

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

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"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/lineage/species"

{  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  },  "species": [    {      "compatibility": {        "min_generation": 0,        "required_flags": [          "string"        ],        "self_compatible": true      },      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "lineage": {        "inbreeding": {          "compute": true,          "max_coefficient": 0.1,          "penalties_enabled": true        },        "track_generations": true      },      "max_lifetime_breedings": 0,      "name": "string",      "parent_count": {        "max": 0,        "min": 0      },      "preview_quantization": {        "bands": 0      },      "species_id": "string",      "traits": [        "string"      ],      "updated_at": "2019-08-24T14:15:22Z",      "version": 0    }  ]}

POST/api/v1/lineage/species

Create_species

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

compatibility?

Compatibility rules

lineage?

Lineage and inbreeding policy

max_lifetime_breedings?integer

Maximum lifetime breedings per parent (0 = unlimited)

Formatint32

Range0 <= value

name*string

Human-readable species name

parent_count*

Allowed parent count window

preview_quantization?

Per-species preview quantization for player-facing previews

traits?array<string>

Trait ids that make up this species' genome

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/lineage/species" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "parent_count": {      "max": 0,      "min": 0    }  }'

{  "compatibility": {    "min_generation": 0,    "required_flags": [      "string"    ],    "self_compatible": true  },  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "lineage": {    "inbreeding": {      "compute": true,      "max_coefficient": 0.1,      "penalties_enabled": true    },    "track_generations": true  },  "max_lifetime_breedings": 0,  "name": "string",  "parent_count": {    "max": 0,    "min": 0  },  "preview_quantization": {    "bands": 0  },  "species_id": "string",  "traits": [    "string"  ],  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

GET/api/v1/lineage/species/{species_id}

Get_species

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

species_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/lineage/species/string"

{  "compatibility": {    "min_generation": 0,    "required_flags": [      "string"    ],    "self_compatible": true  },  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "lineage": {    "inbreeding": {      "compute": true,      "max_coefficient": 0.1,      "penalties_enabled": true    },    "track_generations": true  },  "max_lifetime_breedings": 0,  "name": "string",  "parent_count": {    "max": 0,    "min": 0  },  "preview_quantization": {    "bands": 0  },  "species_id": "string",  "traits": [    "string"  ],  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

DELETE/api/v1/lineage/species/{species_id}

Delete_species

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

species_id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/lineage/species/string"

{  "message": "string",  "species_id": "string"}

PUT/api/v1/lineage/species/{species_id}

Update_species

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

species_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

compatibility?null|

lineage?null|

max_lifetime_breedings?|

New lifetime breeding cap

Formatint32

Range0 <= value

name?|

New species name

parent_count?null|

preview_quantization?null|

traits?array<string>|

Replacement trait id list

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/lineage/species/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "compatibility": {    "min_generation": 0,    "required_flags": [      "string"    ],    "self_compatible": true  },  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "lineage": {    "inbreeding": {      "compute": true,      "max_coefficient": 0.1,      "penalties_enabled": true    },    "track_generations": true  },  "max_lifetime_breedings": 0,  "name": "string",  "parent_count": {    "max": 0,    "min": 0  },  "preview_quantization": {    "bands": 0  },  "species_id": "string",  "traits": [    "string"  ],  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

GET/api/v1/lineage/traits

List_traits

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

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"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/lineage/traits"

{  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  },  "traits": [    {      "alleles": [        {          "carrier_only_visible": true,          "dominance": 0,          "id": "string",          "label": "string"        }      ],      "conflicts_with": [        "string"      ],      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "expression": "highest_dominance",      "hidden": true,      "inheritance": {        "parent_weighting": "equal",        "variance": {          "distribution": "none",          "stddev": 0.1        }      },      "kind": "mendelian",      "mutation": {        "offset_max": 0.1,        "offset_min": 0.1,        "rate": 0.1      },      "name": "string",      "range": null,      "trait_id": "string",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}

POST/api/v1/lineage/traits

Create_trait

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

alleles?array<>

Allele set for mendelian traits

conflicts_with?array<string>

Trait ids this trait conflicts with

expression?MendelianExpression

Expression rule for mendelian traits

Value in

"highest_dominance"
"recessive_only"

hidden?boolean

Whether the trait is hidden (present but not expressed until a descendant)

inheritance?

Inheritance settings for numeric traits

kind*TraitKind

Trait kind (mendelian or numeric)

Value in

"mendelian"
"numeric"

mutation?

Mutation specification

name*string

Human-readable trait name

range?null|

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/lineage/traits" \  -H "Content-Type: application/json" \  -d '{    "kind": "mendelian",    "name": "string"  }'

{  "alleles": [    {      "carrier_only_visible": true,      "dominance": 0,      "id": "string",      "label": "string"    }  ],  "conflicts_with": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "expression": "highest_dominance",  "hidden": true,  "inheritance": {    "parent_weighting": "equal",    "variance": {      "distribution": "none",      "stddev": 0.1    }  },  "kind": "mendelian",  "mutation": {    "offset_max": 0.1,    "offset_min": 0.1,    "rate": 0.1  },  "name": "string",  "range": null,  "trait_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

GET/api/v1/lineage/traits/{trait_id}

Get_trait

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

trait_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/lineage/traits/string"

{  "alleles": [    {      "carrier_only_visible": true,      "dominance": 0,      "id": "string",      "label": "string"    }  ],  "conflicts_with": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "expression": "highest_dominance",  "hidden": true,  "inheritance": {    "parent_weighting": "equal",    "variance": {      "distribution": "none",      "stddev": 0.1    }  },  "kind": "mendelian",  "mutation": {    "offset_max": 0.1,    "offset_min": 0.1,    "rate": 0.1  },  "name": "string",  "range": null,  "trait_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

DELETE/api/v1/lineage/traits/{trait_id}

Delete_trait

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

trait_id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/lineage/traits/string"

{  "message": "string",  "trait_id": "string"}

PUT/api/v1/lineage/traits/{trait_id}

Update_trait

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

trait_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

alleles?array<>|

Replacement allele set

conflicts_with?array<string>|

New conflict list

expression?null|

hidden?|

New hidden flag

inheritance?null|

mutation?null|

name?|

New trait name

range?null|

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/lineage/traits/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "alleles": [    {      "carrier_only_visible": true,      "dominance": 0,      "id": "string",      "label": "string"    }  ],  "conflicts_with": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "expression": "highest_dominance",  "hidden": true,  "inheritance": {    "parent_weighting": "equal",    "variance": {      "distribution": "none",      "stddev": 0.1    }  },  "kind": "mendelian",  "mutation": {    "offset_max": 0.1,    "offset_min": 0.1,    "rate": 0.1  },  "name": "string",  "range": null,  "trait_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

Lineage

201application/json

400

403

404

200application/json

403

404

200application/json

404

200application/json

404

201application/json

400

404

200application/json

400

404

200application/json

200application/json

201application/json

400

403

200application/json

404

200application/json

403

404

200application/json

403

404

200application/json

201application/json

400

403

200application/json

404

200application/json

403

404

200application/json

403

404

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`