Create a task

Authorization

Send a personal access token with every request.

• Authorization: Bearer PAT

Path parameters

• projectIdstringrequired
• orderIdstringrequired

Header parameters

• Idempotency-Keystring

  Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.

Request body

• namestringrequired
• instructionJsonobject
  Hide child attributes
  • enstring
  • zhstring
• startConditionstringrequired
• endConditionstringrequired
• allowedVariationstring | null
• durationMinSnumber | null
• durationMaxSnumber | null
• requiredCamerasarray<string>
• requiredModalitiesarray<string>
• minHandsVisiblenumber | null
• recordingModestring
  Allowed values

  continuous

  single_task
• orderIndexnumberrequired

Responses

{
  "data": {
    "id": "string",
    "orderId": "string",
    "name": "string",
    "instructionJson": {
      "en": "string",
      "zh": "string"
    },
    "demoMediaKeys": [
      "string"
    ],
    "startCondition": "string",
    "endCondition": "string",
    "allowedVariation": "string",
    "durationMinS": 0,
    "durationMaxS": 0,
    "requiredCameras": "other",
    "requiredModalities": "imu",
    "minHandsVisible": 0,
    "recordingMode": "continuous",
    "orderIndex": 0,
    "createdAt": "string",
    "updatedAt": "string",
    "rowVersion": 0
  }
}