Create a cancellation

POST

/v1/projects/{projectId}/annotation-jobs/{jobId}/cancellations

curl -X POST 'https://api.embodiflow.io/v1/projects/{projectId}/annotation-jobs/{jobId}/cancellations' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "unused": "string"
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

projectIdstringrequired
jobIdstringrequired

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

Content-Typeapplication/json

unusedstring | null
Unused. Send an empty JSON object.

Responses

Success

dataobjectrequired
- idstringrequired
- projectIdstringrequired
- kindstringrequired
  Allowed values
  segmentation
  labeling
- namestringrequired
- instructionsMdstring | nullrequired
- exampleEpisodeIdstring | nullrequired
- fieldsJsonarray<string>required
- reviewerMembershipIdstring | nullrequired
- dueAtstring | nullrequired
- statusstringrequired
  Allowed values
  cancelled
  in_review
  in_progress
  open
  done
- distributionstringrequired
  Allowed values
  even
  queue
- createdBystring | nullrequired
- assigneeMembershipIdsarray<string>required
- progressobjectrequired
- createdAtstringrequired
- updatedAtstringrequired
- rowVersionnumberrequired

Response example

{
  "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
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1