# Cancel a sync job

`POST https://stylor.ai/api/v1/datasets/{datasetId}/sources/{sourceId}/sync/jobs/{jobId}/cancel`

- Authentication: private API key, sent as `Authorization: Bearer sgpt-sk-…::…`
- Rate-limit resource: `api.v1.datasets.sources.syncJobs.cancel`
- Demo key: not accepted
- Web page: https://stylor.ai/guides/rest/v1/cancel-sync-job

Removes a job from the queue before a worker picks it up. The request has no
body.

Only `pending` jobs can be cancelled. A cancelled job is recorded as `failed`
with `result.error` set to `Job cancelled by user` and `result.completedAt` set
to the cancellation time; it is purged 7 days later like any other finished job.
No sync log is created.

Jobs that are already `processing` cannot be interrupted — wait for them to
finish. Calling cancel on a `processing`, `completed` or `failed` job returns
`409`.

## Example request

```bash
curl -X POST "https://stylor.ai/api/v1/datasets/YOUR_DATASET_ID/sources/YOUR_SOURCE_ID/sync/jobs/YOUR_JOB_ID/cancel" \
  -H "Authorization: Bearer $STYLOR_API_KEY"
```

## Path parameters

- `datasetId` (string (uuid), required): The dataset the source belongs to.
- `sourceId` (string (uuid), required): The source the job belongs to.
- `jobId` (string (uuid), required): The pending job to cancel.

## Responses

### 200

The job was cancelled.

Content type `application/json`:

- `success` (boolean, required): Always `true` on a 2xx response.
- `message` (string, required): Always `Sync job cancelled successfully`.

Example:

```json
{
  "success": true,
  "message": "Sync job cancelled successfully"
}
```

## Errors

Every error is a JSON object with an `error` string. Match on the status code; the message is written for people.

| Status | Message | When |
| --- | --- | --- |
| 404 | Sync job not found | No job with that `jobId` belongs to the organization that owns the key under the `datasetId` and `sourceId` in the path, or it has already been purged. |
| 409 | Cannot cancel job with status '<status>'. Only pending jobs can be cancelled. | The job is `processing`, `completed` or `failed`. The message names the job's current status. |

### Shared authentication, quota and rate-limit errors

| Status | Message | When |
| --- | --- | --- |
| 401 | API key missing. | The `Authorization` header is absent, is not `Bearer <key>`, or the key does not have three dash-separated segments. |
| 401 | Authentication failed: public key is invalid or not recognized. | A public-key endpoint was called with a key that does not exist. |
| 401 | Authentication failed: private key provided instead of a public key. | A public-key endpoint was called with an `sgpt-sk-…` key. |
| 401 | Authentication failed: token is not recognized. | A private-key endpoint was called with a key whose lookup segment does not exist. |
| 401 | Authentication failed: private key is invalid. | A private-key endpoint was called with a key whose secret does not match. |
| 401 | Authentication failed: public key provided instead of a private key. | A private-key endpoint was called with an `sgpt-pk-…` key. |
| 401 | Authentication failed: bearer token format is invalid. | A private key was sent without its `::` lookup segment. |
| 401 | Authentication failed: API key could not be read. Regenerate the key. | The key's embedded organization data could not be decrypted or parsed. |
| 403 | Demo mode is not available for private-key routes. Demos are only supported with public API keys. | The demo key was sent to a private-key endpoint. |
| 403 | Demo mode is not supported on this API route. Check the documentation for available demo endpoints. | The demo key was sent to a public-key endpoint that opts out of demo mode. |
| 403 | No active subscription for this organization. | The organization that owns the key has no active subscription. |
| 403 | No quota found for organization "<organizationId>". | The organization has no quota record for the current billing period. |
| 403 | No entitlement for "<resource>". | The plan's quota template has no entry for this endpoint. |
| 403 | Access denied to "<resource>". | The plan's quota template turns this endpoint off. |
| 429 | Monthly quota exceeded for "<resource>" (<quota>/<quota> used). | The billing-period quota for this endpoint is exhausted. `Retry-After` gives the seconds until the period resets. |
| 429 | RPM limit exceeded for "<resource>" (<used>/<limit> used). | More than the allowed requests per minute were sent. `Retry-After` is 60. |
| 500 | Internal server error. | An unexpected failure on the server. The message is always this string; details are logged, never returned. Quota consumed by the request is refunded, as it is for every 5xx response. |