Stop Remaining Ad Actions
curl --request POST \
--url https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/action-jobs/{jobId}/cancel \
--header 'x-api-key: <api-key>'const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/action-jobs/{jobId}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/action-jobs/{jobId}/cancel"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text){
"ok": true,
"job": {
"id": "<string>",
"status": "staging",
"actionCount": 1,
"completedCount": 1,
"succeededCount": 1,
"failedCount": 1,
"actions": [
{
"index": 1,
"capabilityId": "<string>",
"label": "<string>",
"status": "staged",
"data": "<unknown>",
"error": "<string>",
"httpStatus": 123,
"retryable": true,
"details": "<unknown>"
}
],
"canRetry": true,
"canCancel": true,
"cancelRequestedAt": "<string>"
}
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}Ad drafts and jobs
Stop Remaining Ad Actions
Request cancellation of the exact saved or running durable ad job. Completed provider changes remain in place; an in-flight write may still finish. Read the job afterward and preserve every accepted provider identity. This does not undo published changes.
POST
/
platform
/
{resourceUrl}
/
action-jobs
/
{jobId}
/
cancel
Stop Remaining Ad Actions
curl --request POST \
--url https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/action-jobs/{jobId}/cancel \
--header 'x-api-key: <api-key>'const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/action-jobs/{jobId}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/action-jobs/{jobId}/cancel"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text){
"ok": true,
"job": {
"id": "<string>",
"status": "staging",
"actionCount": 1,
"completedCount": 1,
"succeededCount": 1,
"failedCount": 1,
"actions": [
{
"index": 1,
"capabilityId": "<string>",
"label": "<string>",
"status": "staged",
"data": "<unknown>",
"error": "<string>",
"httpStatus": 123,
"retryable": true,
"details": "<unknown>"
}
],
"canRetry": true,
"canCancel": true,
"cancelRequestedAt": "<string>"
}
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}Authorizations
ApiKeyAuthBearerAuth
A server-side Bily API key created under Settings > AI tools > Access keys. Select the intended workspace before creating it.
Headers
An organization ID returned by GET /context or GET /organizations. Omit it when a scoped key supplies the organization. Otherwise provide it when no organization is selected.
Example:
"org_01J8W7T9G3E6ZQ4M2K5N8P1R0S"
Path Parameters
Exact workspace URL returned by GET /context.
Identifier returned by the matching Bily read or creation operation.