Skip to main content
POST
Analyze Ad Creative

Authorizations

x-api-key
string
header
required

A server-side Bily API key created under Settings > AI tools > Access keys. Select the intended workspace before creating it.

Headers

x-bily-organization-id
string

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

storeUrl
string
required

Exact workspace URL returned by GET /context.

Body

application/json
platform
enum<string>
required
Available options:
meta,
google
accountId
string
required
creativeId
string
required
mediaKind
enum<string>
required
Available options:
image,
video,
text
depth
enum<string>
Available options:
quick,
deep
metrics
object
adId
string
creativeName
string
Maximum string length: 500
headline
string
Maximum string length: 500
body
string
Maximum string length: 2000
cta
string
Maximum string length: 120

Response

Read the returned identifier until processing reaches a terminal state. Acceptance alone does not confirm completion.

The response is of type object.