Skip to Content
APIEndpointsCancel localization jobs

Cancel localization jobs

Stops jobs that have not finished. A job that already produced a draft keeps it.

Requires the write:localization scope, and the workspace must be enabled for API writes.

POST /v1/brands/{brand_id}/localization/cancel

Authorization

HeaderTypeRequired
AuthorizationBearer asky_sk_…required
Idempotency-Keystringrequired

Path parameters

ParameterTypeRequiredDescription
brand_iduuidrequiredFrom List brands

Body

application/json

FieldTypeRequiredDescription
job_idsuuid[], 1-200requiredFrom List localization jobs

Request

curl --request POST \ --url 'https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/localization/cancel' \ --header 'Authorization: Bearer <api-key>' \ --header 'Idempotency-Key: 5b0e77d2-13a9-4f6a-8ce1-9a3f5e21c0aa' \ --header 'Content-Type: application/json' \ --data '{"job_ids": ["e1c2b3a4-5d6e-4f70-8192-a3b4c5d6e7f8"]}'

Response

{ "data": { "cancelled": true, "job_ids": [ "e1c2b3a4-5d6e-4f70-8192-a3b4c5d6e7f8" ], "count": 1 }, "request_id": "req_2f7b90c14ae8471da3cd" }

Errors

StatusCodeWhen
401invalid_tokenThe key is missing, malformed, or does not exist
403insufficient_scopeThe key does not carry write:localization
403plan_requiredThis workspace is not enabled for API writes
404not_foundThe brand does not exist, or this key is not allowed to reach it
429rate_limitedOver the per-minute limit for this endpoint
Last updated on