AWorld APIs are in a pre-alpha stage and are being updated frequently. For integration inquiries or technical information, please contact us at server@aworld.org.

AWorld API

Create mission

POST

https://api.eu-west-1.aworld.cloud/dashboard/v1/missions

Missions

Creates a new mission with a system-generated ID.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.eu-west-1.aworld.cloud/dashboard/v1/missions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "missionType": "INDIVIDUAL",
    "matchType": "INSTANCE",
    "matchEntity": "Activity",
    "matchEntityId": "string",
    "matchCondition": {},
    "incrementExpression": {},
    "targetAmountExpression": {},
    "defaultLang": "string",
    "translations": [
        {
            "lang": "string",
            "label": "string",
            "description": "string"
        }
    ]
}'

Response Example

{
    "missionId": "string",
    "name": "string",
    "missionType": "INDIVIDUAL",
    "matchType": "INSTANCE",
    "matchEntity": "Activity",
    "matchEntityId": "string",
    "matchCondition": {},
    "incrementExpression": {},
    "targetAmountExpression": {},
    "origin": "CATALOG",
    "missionCatalogId": "string",
    "syncWithCatalog": true,
    "defaultLang": "string",
    "langs": [
        "string"
    ],
    "accountId": "string",
    "workspaceId": "string",
    "sourceRegion": "string",
    "stage": "DRAFT",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Data required to create a new mission.

name

string

required

Name of the mission.

missionType

enum<string>

required

Type of mission.

Allowed values:

INDIVIDUALGROUP

matchType

enum<string>

required

Condition matching type.

Allowed values:

INSTANCEENTITYTAG

matchEntity

enum<string>

required

Entity type for matching.

Allowed values:

ActivityQuizTag

matchEntityId

string

optional

Specific entity ID for matching (optional).

matchCondition

JsonLogicExpression

required

Condition for mission progress. Evaluated against: { mission }.

One of

object

number

boolean

Object representation of a JSON Logic rule

incrementExpression

JsonLogicExpression

required

Expression for progress increment.

One of

object

number

boolean

Object representation of a JSON Logic rule

targetAmountExpression

JsonLogicExpression

required

Expression for target completion amount. Evaluated against: { mission, user? }.

One of

object

number

boolean

Object representation of a JSON Logic rule

defaultLang

string

required

Default language for content.

translations

array[object (MissionTranslation) {3}]

required

List of translations for the mission.

>= 1 items<= 10 items

lang

string

required

Language code for this translation.

label

string

required

Translated label for the mission.

description

string

optional

Translated description for the mission (optional).

Examples

Responses

🟢201Created

application/json

Mission created successfully.

Body

Mission entity representing a set of tasks or objectives for users.

missionId

string

required

Unique identifier for the mission (NanoID).

name

string

required

Name of the mission.

missionType

enum<string>

required

Type of mission (individual or group-based).

Allowed values:

INDIVIDUALGROUP

matchType

enum<string>

required

Determines how the mission's conditions are matched.

Allowed values:

INSTANCEENTITYTAG

matchEntity

enum<string>

required

The entity type the mission's conditions apply to.

Allowed values:

ActivityQuizTag

matchEntityId

string

optional

Specific entity ID for matching (if applicable).

matchCondition

JsonLogicExpression

required

JSON Logic expression defining the refining conditions that defines if the matched entity contributes to mission progress. Evaluated against: { mission }.

One of

object

number

boolean

Object representation of a JSON Logic rule

incrementExpression

JsonLogicExpression

required

JSON Logic expression defining how progress is incremented.

One of

object

number

boolean

Object representation of a JSON Logic rule

targetAmountExpression

JsonLogicExpression

required

JSON Logic expression defining the target amount for mission completion. Evaluated against: { mission, user? } (user is optional and only present for INDIVIDUAL missions).

One of

object

number

boolean

Object representation of a JSON Logic rule

origin

enum<string>

required

Indicates if the mission is from a catalog or custom-created.

Allowed values:

CATALOGCUSTOM

missionCatalogId

string

optional

ID of the mission in the catalog (if applicable).

syncWithCatalog

boolean

optional

Whether the mission should sync with catalog updates.

defaultLang

string

required

Default language code for the mission's content.

langs

array[string]

required

List of available language codes for this mission.

accountId

string

optional

The account ID that owns this mission.

workspaceId

string

optional

The workspace ID that contains this mission.

sourceRegion

string

optional

AWS region where the mission was created.

stage

enum<string>

optional

Current publication stage of the mission.

Allowed values:

DRAFTPUBLISHED

createdAt

string <date-time>

required

Timestamp when the mission was created.

updatedAt

string <date-time>

required

Timestamp when the mission was last updated.

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-06-26 12:45:55

List missions

Get mission by ID