Quest

GET/api/v1/quests/analytics/{quest_id}

Analytics

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

quest_id*string

Query Parameters

window?string

Analytics window (e.g., 30d) reserved for future filtering

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/quests/analytics/string"

{  "abandoned": 0,  "accepted": 0,  "expired": 0,  "quest_id": "string",  "turn_in_rate": 0.1,  "turned_in": 0}

GET/api/v1/quests/definitions

List_definitions

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

q?string

Full-text search query applied to name and description

kind?string

Filter by quest kind

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Page size

Formatint64

Range0 <= value

sort_by?string

Sort field (created_at, name, version)

sort_order?string

Sort order (asc or desc)

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/quests/definitions"

{  "definitions": [    {      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "description": "string",      "kind": "objective",      "name": "string",      "quest_id": "string",      "steps": [        {          "answer": null,          "attempt_throttle": null,          "description": "string",          "hidden": true,          "hints": [            {              "after_seconds": 0,              "order": 0,              "text": "string",              "treasury_price": null            }          ],          "id": "string",          "name": "string",          "objective": null,          "order": 0        }      ],      "updated_at": "2019-08-24T14:15:22Z",      "version": 0    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/quests/definitions

Create_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

branching?array<>

Branching unlocks evaluated on turn-in

description?|

Optional quest description

dispatch?null|

expiry?null|

kind?QuestKind

Quest kind: objective, expedition, or puzzle

Value in

"objective"
"expedition"
"puzzle"

metadata?unknown

Free-form metadata blob

name*string

Human-readable quest name

prerequisites?null|

quest_id*string

Stable quest identifier

resolution?null|

rewards?array<||>

Rewards paid out on turn-in

schedule?null|

step_mode?StepMode

How steps are advanced (ordered or parallel)

Value in

"ordered"
"parallel"

steps?array<>

Ordered or parallel steps

Response Body

`application/json`

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

{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "description": "string",  "kind": "objective",  "name": "string",  "quest_id": "string",  "steps": [    {      "answer": null,      "attempt_throttle": null,      "description": "string",      "hidden": true,      "hints": [        {          "after_seconds": 0,          "order": 0,          "text": "string",          "treasury_price": null        }      ],      "id": "string",      "name": "string",      "objective": null,      "order": 0    }  ],  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

GET/api/v1/quests/definitions/{quest_id}

Get_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

quest_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/quests/definitions/string"

{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "description": "string",  "kind": "objective",  "name": "string",  "quest_id": "string",  "steps": [    {      "answer": null,      "attempt_throttle": null,      "description": "string",      "hidden": true,      "hints": [        {          "after_seconds": 0,          "order": 0,          "text": "string",          "treasury_price": null        }      ],      "id": "string",      "name": "string",      "objective": null,      "order": 0    }  ],  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

DELETE/api/v1/quests/definitions/{quest_id}

Delete_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

quest_id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/quests/definitions/string"

{  "message": "string",  "quest_id": "string"}

PUT/api/v1/quests/definitions/{quest_id}

Update_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

quest_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

branching?array<>|

Replacement branching rules

description?|

New description

expiry?null|

name?|

New quest name

prerequisites?null|

rewards?array<||>|

Replacement rewards

schedule?null|

step_mode?null|

steps?array<>|

Replacement step list

Response Body

`application/json`

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

{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "description": "string",  "kind": "objective",  "name": "string",  "quest_id": "string",  "steps": [    {      "answer": null,      "attempt_throttle": null,      "description": "string",      "hidden": true,      "hints": [        {          "after_seconds": 0,          "order": 0,          "text": "string",          "treasury_price": null        }      ],      "id": "string",      "name": "string",      "objective": null,      "order": 0    }  ],  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

POST/api/v1/quests/events

Emit_events

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

events*array<>

One or more progress events to apply

subject_user_id?|

Trusted service-to-service subject the events apply to (admin only)

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/quests/events" \  -H "Content-Type: application/json" \  -d '{    "events": [      {        "event_type": "string",        "idempotency_key": "string"      }    ]  }'

{  "deltas": [    {      "count": 0,      "quest_id": "string",      "ready_for_turn_in": true,      "step_completed": true,      "step_id": "string"    }  ]}

GET/api/v1/quests/log

Quest_log

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

status?string

Filter by quest status (offered, accepted, in_progress, turned_in, expired, abandoned)

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/quests/log"

{  "quests": [    {      "accepted_at": 0,      "current_step": "string",      "cycle_key": "string",      "definition_version": 0,      "expedition": null,      "expires_at": 0,      "hints_unlocked": [        "string"      ],      "kind": "objective",      "quest_id": "string",      "rewards_claimed": true,      "status": "offered",      "step_progress": {        "property1": {          "completed": true,          "count": 0        },        "property2": {          "completed": true,          "count": 0        }      },      "user_id": "string"    }  ]}

GET/api/v1/quests/offered

Offered_quests

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/quests/offered"

{  "offered": [    {      "description": "string",      "kind": "objective",      "name": "string",      "quest_id": "string",      "version": 0    }  ]}

POST/api/v1/quests/{quest_id}/abandon

Abandon_quest

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

quest_id*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/quests/string/abandon"

{  "quest_id": "string",  "status": "offered"}

POST/api/v1/quests/{quest_id}/accept

Accept_quest

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

quest_id*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/quests/string/accept"

{  "accepted_at": 0,  "current_step": "string",  "cycle_key": "string",  "definition_version": 0,  "expedition": null,  "expires_at": 0,  "hints_unlocked": [    "string"  ],  "kind": "objective",  "quest_id": "string",  "rewards_claimed": true,  "status": "offered",  "step_progress": {    "property1": {      "completed": true,      "count": 0    },    "property2": {      "completed": true,      "count": 0    }  },  "user_id": "string"}

POST/api/v1/quests/{quest_id}/check-in

Check_in

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

quest_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

early?boolean

Whether to resolve early before the expedition return time

Response Body

`application/json`

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

{  "outcomes": [    "string"  ],  "quest_id": "string",  "resolved": true}

POST/api/v1/quests/{quest_id}/dispatch

Dispatch

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

quest_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

party*array<string>

Party member identifiers to send on the expedition

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/quests/string/dispatch" \  -H "Content-Type: application/json" \  -d '{    "party": [      "string"    ]  }'

{  "party": [    "string"  ],  "quest_id": "string",  "resolves_at": 0}

POST/api/v1/quests/{quest_id}/rewards/resume

Resume_rewards

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

quest_id*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/quests/string/rewards/resume"

{  "quest_id": "string",  "rewards": [    {      "detail": "string",      "reward": {        "amount": 0,        "currency": "string",        "type": "treasury"      },      "status": "string"    }  ]}

POST/api/v1/quests/{quest_id}/steps/{step_id}/answer

Answer_step

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

quest_id*string

step_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

text*string

Submitted answer text for the puzzle step

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/quests/string/steps/string/answer" \  -H "Content-Type: application/json" \  -d '{    "text": "string"  }'

{  "attempts_remaining": 0,  "correct": true,  "quest_id": "string",  "ready_for_turn_in": true,  "step_completed": true,  "step_id": "string"}

GET/api/v1/quests/{quest_id}/steps/{step_id}/hints

List_hints

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

quest_id*string

step_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/quests/string/steps/string/hints"

{  "hints": [    {      "order": 0,      "text": "string",      "unlock_condition": "string",      "unlocked": true    }  ],  "quest_id": "string",  "step_id": "string"}

POST/api/v1/quests/{quest_id}/steps/{step_id}/hints/unlock

Unlock_hint

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

quest_id*string

step_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

order*integer

Hint order to unlock (for time-gated or paid hints)

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/quests/string/steps/string/hints/unlock" \  -H "Content-Type: application/json" \  -d '{    "order": 0  }'

{  "hint": {    "order": 0,    "text": "string",    "unlock_condition": "string",    "unlocked": true  },  "quest_id": "string",  "step_id": "string"}

POST/api/v1/quests/{quest_id}/turn-in

Turn_in

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

quest_id*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/quests/string/turn-in"

{  "quest_id": "string",  "rewards": [    {      "detail": "string",      "reward": {        "amount": 0,        "currency": "string",        "type": "treasury"      },      "status": "string"    }  ],  "status": "offered",  "unlocked": [    "string"  ]}

Quest

200application/json

403

404

200application/json

201application/json

400

403

409

200application/json

404

200application/json

403

404

200application/json

400

403

404

200application/json

400

403

200application/json

200application/json

200application/json

404

409

200application/json

403

404

409

200application/json

404

409

200application/json

400

404

409

200application/json

404

409

200application/json

400

404

429

200application/json

404

200application/json

400

404

409

200application/json

404

409

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`