API Reference

Create a quest

post
https://forge.gg/forge-direct/v1/quests

Access

This endpoint requires API key (header X-API-KEY).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Schema for creating a new quest, combining base quest configuration and template-specific settings.

string
required

Template name

string
length ≤ 255

Quest title displayed to users

string | null

Quest description (may contain HTML for links)

number
required
≥ 0

Base points awarded for completing this quest

boolean
required

Whether this quest is currently active and available to users

date-time
required

When this quest becomes available to users

date-time

When this quest expires and is no longer available

integer

Display order for sorting quests in UI (lower numbers appear first)

boolean

Whether this quest should be hidden from quest lists (but still accessible via direct link)

quest_variables
object
required

Template variables and computed values used for quest generation and display.
Often contains processed versions of data from variable_json plus additional context.

string | null

The background image URL for the quest

tags
array of strings | null

List of tags for categorizing quests (e.g. "social", "game", "social", "partnership")

tags
config

Extra configuration required for surprise_option and quiz_option templates

unlock_condition
array of objects
unlock_condition
Responses

Updated 8 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago

Did this page help you?