Create a annotation job

Authorization

Send a personal access token with every request.

• Authorization: Bearer PAT

Path parameters

• projectIdstringrequired

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

• kindstringrequired
• namestringrequired
• instructionsMdstring | null
• exampleEpisodeIdstring | null
• fieldsJsonarray<string>
• reviewerMembershipIdstring | null
• dueAtstring | null
• distributionstringrequired
• assigneeMembershipIdsarray<string>required
• selectionobjectrequired

Responses

{
  "data": {
    "id": "string",
    "projectId": "string",
    "kind": "segmentation",
    "name": "string",
    "instructionsMd": "string",
    "exampleEpisodeId": "string",
    "fieldsJson": [
      "string"
    ],
    "reviewerMembershipId": "string",
    "dueAt": "string",
    "status": "cancelled",
    "distribution": "even",
    "createdBy": "string",
    "assigneeMembershipIds": [
      "string"
    ],
    "progress": {
      "total": 0,
      "todo": 0,
      "labeled": 0,
      "approved": 0,
      "rejected": 0
    },
    "createdAt": "string",
    "updatedAt": "string",
    "rowVersion": 0
  }
}