Skip to main content
POST
Stage a low-level ad action job

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

resourceUrl
string
required

Exact workspace URL returned by GET /context.

Body

application/json
actionCount
integer
Required range: 1 <= x <= 100
actions
object[]
Required array length: 1 - 100 elements
autoStart
boolean

Use false for explicit review. Inline actions otherwise start automatically.

idempotencyKey
string
stopOnFailure
boolean

Response

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

ok
any
required
job
object
required