Cancel the training job for this model
POST
/v1/models/{modelId}/cancellation-requestscurl -X POST 'https://api.embodiflow.io/v1/models/{modelId}/cancellation-requests' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT' \
-H 'Content-Type: application/json' \
-d '{
"reason": "string"
}'Authorization
Send a personal access token with every request.
- Authorization: Bearer PAT
Path parameters
- modelIdstringrequired
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
- reasonstring | null
Responses
Success
- dataobjectrequired
- idstringrequired
- tenantIdstringrequired
- projectIdstringrequired
- trainingArtifactIdstringrequired
- modelImageRevisionIdstringrequired
- computeProfileCodestringrequired
- trainSpecobject | nullrequired
- desiredStatestringrequired
- statusstringrequired
- resumeFromCheckpointArtifactIdstring | nullrequired
- latestAttemptIdstring | nullrequired
- registeredModelVersionIdstring | nullrequired
- metricsSummaryobject | nullrequired
- failureSummaryobject | nullrequired
- modelstring | nullrequired
- frameworkstring | nullrequired
- outputArtifactIdstring | nullrequired
- datasetVersionIdstring | null
- inputProvenanceone of | null
- gpuClassCodestring | null
- gpuCountnumber | null
- cancelRequestedAtstring | nullrequired
- finishedAtstring | nullrequired
- createdAtstringrequired
- updatedAtstringrequired
Response example
{
"data": {
"id": "string",
"tenantId": "string",
"projectId": "string",
"trainingArtifactId": "string",
"modelImageRevisionId": "string",
"computeProfileCode": "string",
"trainSpec": {},
"desiredState": "string",
"status": "string",
"resumeFromCheckpointArtifactId": "string",
"latestAttemptId": "string",
"registeredModelVersionId": "string",
"metricsSummary": {},
"failureSummary": {},
"model": "string",
"framework": "string",
"outputArtifactId": "string",
"datasetVersionId": "string",
"inputProvenance": {
"kind": "export-derived",
"datasetVersionId": "string"
},
"gpuClassCode": "string",
"gpuCount": 0,
"cancelRequestedAt": "string",
"finishedAt": "string",
"createdAt": "string",
"updatedAt": "string"
}
}Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1