variation_list
List the Variations of one Creative of your Library, each with the Asset that it holds.
Ask for each file of a large Creative. library_creative_get already gives the first 100 Variations. The agent reads the next pages with this tool.
“List every file of the Spring sale creative.”
The agent reads the Creative, and then calls this tool with the cursor that the read gave, until the list ends. You see each Variation, newest first, with its file, its kind and its dimensions.
This tool is part of the job Bring your own creative.
Reference
List the Variations of one Creative of your Library, newest first. Each Variation holds one Asset, and the Asset comes with it. library_creative_get already holds the first page: use this tool for the next pages, with its variations.nextCursor as cursor. A cursor of the Variations of one Creative does not work for another Creative. The answer holds at most limit rows (default 100, maximum 500). When it carries nextCursor, more rows exist: call this tool again with the same arguments and cursor set to that value. When it carries no nextCursor, you have every row.
Input
| Argument | Type | Required | Description |
|---|---|---|---|
creative_id |
string | yes | The id of a Creative of your Library (crv_…). library_creative_list gives it. |
cursor |
string, at least 1 character | no | The nextCursor of the previous page. Omit it to get the first page. Send it with no change, and with the same filters as the request that answered it: a cursor from a different query gets a 400 invalid_cursor. Do not build or change a cursor. |
limit |
integer, 1 to 500 | no | The greatest number of rows on the page, from 1 to 500. The default is 100. A greater value gets a 400, with error of invalid_request. Default: 100. |
Output
A successful call returns this object in structuredContent.
| Field | Type | Always present | Description |
|---|---|---|---|
nextCursor |
string | no | Send this value as cursor to get the next page. It is absent on the last page. |
variations |
array of object | yes | The Variations of this page, newest first, each with the Asset that it holds. A removed Variation is not in the list. |
variations[].asset |
object | yes | |
variations[].asset.contentHash |
string | yes | AdCrunch’s own hash of the stored bytes. A hint for de-duplication, never an identity, and never a provider’s hash. Empty when the store reports none. |
variations[].asset.createdAt |
number | yes | Milliseconds since the Unix epoch, UTC. |
variations[].asset.createdBy |
string | yes | The user who reserved the upload. |
variations[].asset.deletedAt |
number or null | yes | Always null here. A deleted Asset is not answered. |
variations[].asset.durationMs |
number or null | yes | How long the video runs, in milliseconds, read from the header of the file at finalize. null for an image. For a video, null when the file does not state it, or for an Asset uploaded before AdCrunch read it. |
variations[].asset.failureCode |
string or null | yes | Why AdCrunch refused the file, as a code. Branch on this field, never on failureReason. unsupported_type: the bytes are not an accepted image or video. too_large: the file is over the size limit. unreadable: AdCrunch could not read the header of the file. source_unreachable: an import could not fetch the file from its source URL. source_length_unknown: the source of an import sent no Content-Length. null unless status is failed. |
variations[].asset.failureReason |
string or null | yes | Why AdCrunch refused the file, as a sentence. null unless status is failed. |
variations[].asset.filename |
string | yes | The name the file was uploaded under. Never a lookup key. |
variations[].asset.height |
number or null | yes | The height in pixels as the file is displayed, with its rotation applied, read from the header of the file at finalize. null when the file does not state it, or for an Asset uploaded before AdCrunch read it. |
variations[].asset.id |
string | yes | The id of the Asset, ast_…. |
variations[].asset.key |
string | yes | Where the bytes are held. Read-only, and never sent by you. |
variations[].asset.kind |
one of image, video |
yes | Follows from mimeType. It selects how a provider takes the file. |
variations[].asset.mimeType |
string | yes | The type that finalize identified from the stored bytes. The Content-Type of the upload does not set it. |
variations[].asset.name |
string or null | yes | The name a person gave this Asset, and what a provider receives at a future registration. null until somebody renames it, and the filename is the fallback. |
variations[].asset.organizationId |
string | yes | The organization that owns the Asset. |
variations[].asset.sizeBytes |
number | yes | Read from the stored object at finalize. |
variations[].asset.status |
one of pending, ready, failed |
yes | ready once AdCrunch has inspected the bytes. Only a ready Asset can be registered. pending: the bytes have not been inspected yet. failed: AdCrunch refused the file and deleted it. failureCode and failureReason say why. A read answers an Asset in every status. A list answers ready Assets only. |
variations[].asset.updatedAt |
number or null | yes | When the Asset last changed, in milliseconds since the Unix epoch, UTC: at finalize, or at the last rename. |
variations[].asset.width |
number or null | yes | The width in pixels as the file is displayed, with its rotation applied, read from the header of the file at finalize. null when the file does not state it, or for an Asset uploaded before AdCrunch read it. |
variations[].assetId |
string | yes | The id of the Asset that the Variation holds, ast_…. asset is that Asset. Its width, height and durationMs give the dimensions of the Variation. |
variations[].brokenRules |
array of object | yes | The rules of the Placement that the Asset breaks, as the Placement stores them. They are advice: AdCrunch wrote the Variation anyway. Empty when placement is null. AdCrunch computes this list at each read, so a change of the rules of the Placement changes the next read. |
variations[].brokenRules[].type |
width or height or size or ratio or mime or duration |
yes | |
variations[].brokenRules[].operator |
object | yes | Only when type is width. |
variations[].brokenRules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is eq. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is ne. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is lt. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is lte. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is gt. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is gte. |
variations[].brokenRules[].operator.value |
array of (integer, at least 0), 1 to 50 items | yes | Only when condition is in. |
variations[].brokenRules[].operator |
object | yes | Only when type is height. |
variations[].brokenRules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is eq. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is ne. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is lt. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is lte. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is gt. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is gte. |
variations[].brokenRules[].operator.value |
array of (integer, at least 0), 1 to 50 items | yes | Only when condition is in. |
variations[].brokenRules[].operator |
object | yes | Only when type is size. |
variations[].brokenRules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is eq. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is ne. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is lt. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is lte. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is gt. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is gte. |
variations[].brokenRules[].operator.value |
array of (integer, at least 0), 1 to 50 items | yes | Only when condition is in. |
variations[].brokenRules[].operator |
object | yes | Only when type is ratio. |
variations[].brokenRules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
variations[].brokenRules[].operator.value |
array of any, 2 items | yes | Only when condition is eq. |
variations[].brokenRules[].operator.value |
array of any, 2 items | yes | Only when condition is ne. |
variations[].brokenRules[].operator.value |
array of any, 2 items | yes | Only when condition is lt. |
variations[].brokenRules[].operator.value |
array of any, 2 items | yes | Only when condition is lte. |
variations[].brokenRules[].operator.value |
array of any, 2 items | yes | Only when condition is gt. |
variations[].brokenRules[].operator.value |
array of any, 2 items | yes | Only when condition is gte. |
variations[].brokenRules[].operator.value |
array of (array of any, 2 items), 1 to 50 items | yes | Only when condition is in. |
variations[].brokenRules[].operator |
object | yes | Only when type is mime. |
variations[].brokenRules[].operator.condition |
eq or ne or in |
yes | |
variations[].brokenRules[].operator.value |
string, 1 to 255 characters | yes | Only when condition is eq. |
variations[].brokenRules[].operator.value |
string, 1 to 255 characters | yes | Only when condition is ne. |
variations[].brokenRules[].operator.value |
array of (string, 1 to 255 characters), 1 to 50 items | yes | Only when condition is in. |
variations[].brokenRules[].operator |
object | yes | Only when type is duration. |
variations[].brokenRules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is eq. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is ne. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is lt. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is lte. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is gt. |
variations[].brokenRules[].operator.value |
integer, at least 0 | yes | Only when condition is gte. |
variations[].brokenRules[].operator.value |
array of (integer, at least 0), 1 to 50 items | yes | Only when condition is in. |
variations[].createdAt |
number | yes | Milliseconds since the Unix epoch, UTC. |
variations[].createdBy |
string | yes | The user who added the Variation. |
variations[].creativeId |
string | yes | The Creative that the Variation belongs to, crv_…. |
variations[].deletedAt |
number or null | yes | Always null here. A removed Variation is not answered. |
variations[].id |
string | yes | The id of the Variation, var_…. |
variations[].organizationId |
string | yes | The organization that owns the Creative. |
variations[].placement |
object or null | yes | The Placement that the Variation names, or null. null also when the Placement was deleted after the Variation named it. |
variations[].placement.channel |
one of meta, tiktok, snapchat, google_search, google_pmax, google_display, youtube, programmatic_display, linkedin, x |
yes | The channel of a Line Item that the Placement belongs to. |
variations[].placement.id |
string | yes | The id of the Placement, plm_…. |
variations[].placement.name |
string | yes | The name of the Placement. |
variations[].placement.type |
one of image, video |
yes | The kind of Asset that the Placement takes. |
variations[].placementId |
string or null | yes | The id of the Placement that the Variation names, plm_…, or null when it names none. |
variations[].unknownRules |
array of object | yes | The rules of the Placement that need a fact that the Asset does not have: a width, a height, a duration or a ratio of an Asset that AdCrunch could not read. They are neither held nor broken. Empty when placement is null. AdCrunch computes this list at each read. |
variations[].unknownRules[].type |
width or height or size or ratio or mime or duration |
yes | |
variations[].unknownRules[].operator |
object | yes | Only when type is width. |
variations[].unknownRules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is eq. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is ne. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is lt. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is lte. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is gt. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is gte. |
variations[].unknownRules[].operator.value |
array of (integer, at least 0), 1 to 50 items | yes | Only when condition is in. |
variations[].unknownRules[].operator |
object | yes | Only when type is height. |
variations[].unknownRules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is eq. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is ne. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is lt. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is lte. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is gt. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is gte. |
variations[].unknownRules[].operator.value |
array of (integer, at least 0), 1 to 50 items | yes | Only when condition is in. |
variations[].unknownRules[].operator |
object | yes | Only when type is size. |
variations[].unknownRules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is eq. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is ne. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is lt. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is lte. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is gt. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is gte. |
variations[].unknownRules[].operator.value |
array of (integer, at least 0), 1 to 50 items | yes | Only when condition is in. |
variations[].unknownRules[].operator |
object | yes | Only when type is ratio. |
variations[].unknownRules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
variations[].unknownRules[].operator.value |
array of any, 2 items | yes | Only when condition is eq. |
variations[].unknownRules[].operator.value |
array of any, 2 items | yes | Only when condition is ne. |
variations[].unknownRules[].operator.value |
array of any, 2 items | yes | Only when condition is lt. |
variations[].unknownRules[].operator.value |
array of any, 2 items | yes | Only when condition is lte. |
variations[].unknownRules[].operator.value |
array of any, 2 items | yes | Only when condition is gt. |
variations[].unknownRules[].operator.value |
array of any, 2 items | yes | Only when condition is gte. |
variations[].unknownRules[].operator.value |
array of (array of any, 2 items), 1 to 50 items | yes | Only when condition is in. |
variations[].unknownRules[].operator |
object | yes | Only when type is mime. |
variations[].unknownRules[].operator.condition |
eq or ne or in |
yes | |
variations[].unknownRules[].operator.value |
string, 1 to 255 characters | yes | Only when condition is eq. |
variations[].unknownRules[].operator.value |
string, 1 to 255 characters | yes | Only when condition is ne. |
variations[].unknownRules[].operator.value |
array of (string, 1 to 255 characters), 1 to 50 items | yes | Only when condition is in. |
variations[].unknownRules[].operator |
object | yes | Only when type is duration. |
variations[].unknownRules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is eq. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is ne. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is lt. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is lte. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is gt. |
variations[].unknownRules[].operator.value |
integer, at least 0 | yes | Only when condition is gte. |
variations[].unknownRules[].operator.value |
array of (integer, at least 0), 1 to 50 items | yes | Only when condition is in. |
variations[].updatedAt |
number or null | yes | When the Placement of the Variation last changed, or null when it never did. Only the Placement changes: the Asset of a Variation never changes. |
Failure codes
A failed call has isError set, and structuredContent.error holds one of these codes. Errors describes the shape of a failed call.
invalid_cursornot_foundorganization_unentitledforbiddeninvalid_requestinternal_error
Scope
The token must hold library:read. Auth & scopes lists each scope.
Annotations
A client reads these hints. A hint that the tool does not declare has the default value of the MCP specification.
- Read-only. The tool changes nothing.
- Closed world. The tool reads and writes the data of AdCrunch only.
Example
The arguments:
{
"creative_id": "crv_5e2a19"
}
The result, in structuredContent:
{
"variations": [
{
"asset": {
"contentHash": "9d2f41b7c6e8a35014f7b2d9c3e6a810",
"createdAt": 1790000000000,
"createdBy": "usr_2e5b84",
"deletedAt": null,
"durationMs": 15000,
"failureCode": null,
"failureReason": null,
"filename": "spring-sale.mp4",
"height": 1920,
"id": "ast_7c1e9a",
"key": "org_3a7f10/ast_7c1e9a",
"kind": "video",
"mimeType": "video/mp4",
"name": "Spring sale 9:16",
"organizationId": "org_3a7f10",
"sizeBytes": 24117248,
"status": "ready",
"updatedAt": 1790000120000,
"width": 1080
},
"assetId": "ast_7c1e9a",
"brokenRules": [],
"createdAt": 1790000360000,
"createdBy": "usr_2e5b84",
"creativeId": "crv_5e2a19",
"deletedAt": null,
"id": "var_8c3f60",
"organizationId": "org_3a7f10",
"placement": {
"channel": "meta",
"id": "plm_meta_stories_video",
"name": "Meta Stories video",
"type": "video"
},
"placementId": "plm_meta_stories_video",
"unknownRules": [],
"updatedAt": null
},
{
"asset": {
"contentHash": "4a7e1c9b0d3f26854b1e7a9c2d6f3081",
"createdAt": 1789900000000,
"createdBy": "usr_2e5b84",
"deletedAt": null,
"durationMs": null,
"failureCode": null,
"failureReason": null,
"filename": "spring-sale-square.jpg",
"height": 1080,
"id": "ast_2d4f83",
"key": "org_3a7f10/ast_2d4f83",
"kind": "image",
"mimeType": "image/jpeg",
"name": null,
"organizationId": "org_3a7f10",
"sizeBytes": 486112,
"status": "ready",
"updatedAt": 1789900090000,
"width": 1080
},
"assetId": "ast_2d4f83",
"brokenRules": [],
"createdAt": 1790000350000,
"createdBy": "usr_2e5b84",
"creativeId": "crv_5e2a19",
"deletedAt": null,
"id": "var_1d7b42",
"organizationId": "org_3a7f10",
"placement": null,
"placementId": null,
"unknownRules": [],
"updatedAt": null
}
]
}