curl --request POST \
--url https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/actions/read-meta-asset \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"adAccountId": "<string>",
"sourceAuthority": {
"dataSourceAdAccountId": "<string>",
"dataSourceConnectorId": "<string>"
},
"payload": {
"assetType": "account",
"assetId": "<string>",
"forAwareness": true
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
adAccountId: '<string>',
sourceAuthority: {dataSourceAdAccountId: '<string>', dataSourceConnectorId: '<string>'},
payload: {assetType: 'account', assetId: '<string>', forAwareness: true}
})
};
fetch('https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/actions/read-meta-asset', 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}/actions/read-meta-asset"
payload = {
"adAccountId": "<string>",
"sourceAuthority": {
"dataSourceAdAccountId": "<string>",
"dataSourceConnectorId": "<string>"
},
"payload": {
"assetType": "account",
"assetId": "<string>",
"forAwareness": True
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){}{
"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>"
}Read Meta Asset for Row Editing
Read the exact connected Meta campaign, ad set, website image or static carousel creative, including budget ownership and a stale-draft fingerprint. For a carousel use forCarousel:true; ad-set reads can includeCarouselAssets:true to list bounded retained images, promotable Pages and Instagram identities. For a complete Awareness Reach image package use assetType:account, the numeric advertiser assetId and forAwareness:true. For the dedicated website Leads image family use forWebsiteLeads:true to review current account, Page, retained-image and workspace-pixel fingerprints; pixels are intersected with the selected advertiser native edge. Its attributionWindow is the supported fixed ONE_DAY_CLICK profile. Image fingerprints exclude signed media URLs.
curl --request POST \
--url https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/actions/read-meta-asset \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"adAccountId": "<string>",
"sourceAuthority": {
"dataSourceAdAccountId": "<string>",
"dataSourceConnectorId": "<string>"
},
"payload": {
"assetType": "account",
"assetId": "<string>",
"forAwareness": true
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
adAccountId: '<string>',
sourceAuthority: {dataSourceAdAccountId: '<string>', dataSourceConnectorId: '<string>'},
payload: {assetType: 'account', assetId: '<string>', forAwareness: true}
})
};
fetch('https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/actions/read-meta-asset', 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}/actions/read-meta-asset"
payload = {
"adAccountId": "<string>",
"sourceAuthority": {
"dataSourceAdAccountId": "<string>",
"dataSourceConnectorId": "<string>"
},
"payload": {
"assetType": "account",
"assetId": "<string>",
"forAwareness": True
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){}{
"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
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.
"org_01J8W7T9G3E6ZQ4M2K5N8P1R0S"
Path Parameters
Exact workspace URL returned by GET /context.
Body
Response
Request completed. Inspect the returned state and any verification fields.
The response is of type object.