Jobs

Cancel job

Cancel a running job.

post/api/{projectId}/jobs/{jobId}/cancel

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/jobs/:jobId/cancel/post.ts
A function with typed inputs. Its response is checked against the schema.

projectIdinteger required

Project ID

jobIdinteger required

Job ID

forceCancelstring

If set to 'true', we won't wait for the job cluster to cancel the job, and will mark the job as finished.

successboolean required

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

No recorded changes to this operation across all 1 revision of this API.