Skip to content
AdCrunch
Esc
↑↓navigate↵open⌘Jpreview
On this page

library_creative_get

Read one Creative of your Library with its Variations, each with the Asset that it holds.

Ask what makes up one ad idea. The agent reads the Creative, and its Variations come with it: up to 100, newest first, each with its Asset.

“Which files are in the Spring sale creative?”

The agent finds the Creative with library_creative_list, and reads it with this tool. You see each Variation with its file, its kind and its dimensions, for example a 9:16 video and a square image. When the Creative holds more than 100 Variations, the agent reads the next pages with variation_list.

This tool is part of the job Bring your own creative.

Reference

Read one Creative of your Library with its Variations: up to 100, newest first, each with the Asset that it holds. The width, height and durationMs of each Asset give the dimensions of its Variation. When the Creative holds more Variations, variations.nextCursor is the cursor of variation_list for the next page. A Creative of your Library is an ad idea of your organization, with its Variations. It is not the creative of an ad account, which list_creatives lists.

Input

Argument Type Required Description
creative_id string yes The id of a Creative of your Library (crv_…). library_creative_list gives it.

Output

A successful call returns this object in structuredContent.

Field Type Always present Description
creative object yes The Creative, with its count of Variations and the first page of its Variations in variations: up to 100, newest first, each with its Asset.
creative.createdAt number yes Milliseconds since the Unix epoch, UTC.
creative.createdBy string yes The user who created the Creative.
creative.deletedAt number or null yes Always null here. A deleted Creative is not answered.
creative.id string yes The id of the Creative, crv_….
creative.name string or null yes The name a person gave the Creative. null when nobody named it. There is no fallback name.
creative.organizationId string yes The organization that owns the Creative.
creative.updatedAt number or null yes When the Creative last changed, in milliseconds since the Unix epoch, UTC. null until its first rename.
creative.variationCount number yes How many live Variations the Creative holds. The read of one Creative holds the first page of them, and the list of the Variations of the Creative gives each page.
creative.variations object yes
creative.variations.data array of object yes
creative.variations.data[].asset object yes
creative.variations.data[].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.
creative.variations.data[].asset.createdAt number yes Milliseconds since the Unix epoch, UTC.
creative.variations.data[].asset.createdBy string yes The user who reserved the upload.
creative.variations.data[].asset.deletedAt number or null yes Always null here. A deleted Asset is not answered.
creative.variations.data[].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.
creative.variations.data[].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.
creative.variations.data[].asset.failureReason string or null yes Why AdCrunch refused the file, as a sentence. null unless status is failed.
creative.variations.data[].asset.filename string yes The name the file was uploaded under. Never a lookup key.
creative.variations.data[].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.
creative.variations.data[].asset.id string yes The id of the Asset, ast_….
creative.variations.data[].asset.key string yes Where the bytes are held. Read-only, and never sent by you.
creative.variations.data[].asset.kind one of image, video yes Follows from mimeType. It selects how a provider takes the file.
creative.variations.data[].asset.mimeType string yes The type that finalize identified from the stored bytes. The Content-Type of the upload does not set it.
creative.variations.data[].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.
creative.variations.data[].asset.organizationId string yes The organization that owns the Asset.
creative.variations.data[].asset.sizeBytes number yes Read from the stored object at finalize.
creative.variations.data[].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.
creative.variations.data[].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.
creative.variations.data[].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.
creative.variations.data[].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.
creative.variations.data[].createdAt number yes Milliseconds since the Unix epoch, UTC.
creative.variations.data[].createdBy string yes The user who added the Variation.
creative.variations.data[].creativeId string yes The Creative that the Variation belongs to, crv_….
creative.variations.data[].deletedAt number or null yes Always null here. A removed Variation is not answered.
creative.variations.data[].id string yes The id of the Variation, var_….
creative.variations.data[].organizationId string yes The organization that owns the Creative.
creative.variations.data[].updatedAt number or null yes Always null here. A Variation has no update: to use another Asset, remove the Variation and add a new one.
creative.variations.nextCursor string no Send this value as cursor to get the next page. It is absent on the last page.

Failure codes

A failed call has isError set, and structuredContent.error holds one of these codes. Errors describes the shape of a failed call.

  • not_found
  • organization_unentitled
  • forbidden
  • invalid_request
  • internal_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:

{
  "creative": {
    "createdAt": 1790000300000,
    "createdBy": "usr_2e5b84",
    "deletedAt": null,
    "id": "crv_5e2a19",
    "name": "Spring sale",
    "organizationId": "org_3a7f10",
    "updatedAt": null,
    "variationCount": 2,
    "variations": {
      "data": [
        {
          "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",
          "createdAt": 1790000360000,
          "createdBy": "usr_2e5b84",
          "creativeId": "crv_5e2a19",
          "deletedAt": null,
          "id": "var_8c3f60",
          "organizationId": "org_3a7f10",
          "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",
          "createdAt": 1790000350000,
          "createdBy": "usr_2e5b84",
          "creativeId": "crv_5e2a19",
          "deletedAt": null,
          "id": "var_1d7b42",
          "organizationId": "org_3a7f10",
          "updatedAt": null
        }
      ]
    }
  }
}

Was this page helpful?