Stage one action in a job
curl --request PUT \
--url https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/action-jobs/{jobId}/actions/{index} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"capabilityId": "<string>",
"body": {}
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({capabilityId: '<string>', body: JSON.stringify({})})
};
fetch('https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/action-jobs/{jobId}/actions/{index}', 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}/actions/{index}"
payload = {
"capabilityId": "<string>",
"body": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"jobId": "<string>",
"action": {}
}{
"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
Stage one action in a job
Write one supported action into a staging job. Indexes start at zero. The body is immutable once staged; this does not publish the job.
PUT
/
platform
/
{resourceUrl}
/
action-jobs
/
{jobId}
/
actions
/
{index}
Stage one action in a job
curl --request PUT \
--url https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/action-jobs/{jobId}/actions/{index} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"capabilityId": "<string>",
"body": {}
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({capabilityId: '<string>', body: JSON.stringify({})})
};
fetch('https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/action-jobs/{jobId}/actions/{index}', 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}/actions/{index}"
payload = {
"capabilityId": "<string>",
"body": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"jobId": "<string>",
"action": {}
}{
"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.
Identifier returned by the matching Bily read or creation operation.
Required range:
0 <= x <= 99