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

Get one Asset

Fetches one Asset in any status (pending, ready or failed), with its Registrations and a short-lived presigned previewUrl for the stored bytes of a ready Asset (null for a pending or failed Asset). An Asset belonging to another organization is reported as missing, so the surface cannot be used to discover that an id is real.

A read completes a reserved Asset. When the Asset is pending and its object exists, the read inspects the bytes and answers the Asset ready or failed. A read before the PUT answers pending: read again after the PUT.

This is also how a Registration is polled: status and providerIdentifier on each Registration settle here, and there is no separate status resource.

GET/assets/{id}
Authorization
AuthorizationBearer token · headerrequired

Send Authorization: Bearer <credential>.

Use an API key (acr_…), from the AdCrunch console under Settings → API keys.

The credential names the organization, and no operation takes an organization parameter.

See https://docs.adcrunch.dev/api/authentication.

Path parameters
idstringrequired
matches ^(ast_)[\s\S]{0,}$
Responses
200

The Asset, its Registrations, and a signed link to the bytes that expires in 15 minutes.

contentHashstringrequired

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.

createdAtnumberrequired

Milliseconds since the Unix epoch, UTC.

createdBystringrequired

The user who reserved the upload.

deletedAtnumber | nullrequired

Always null here. A deleted Asset is not answered.

durationMsnumber | nullrequired

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.

failureCodestring | nullrequired

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.

failureReasonstring | nullrequired

Why AdCrunch refused the file, as a sentence. null unless status is failed.

filenamestringrequired

The name the file was uploaded under. Never a lookup key.

heightnumber | nullrequired

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.

idstringrequired

The id of the Asset, ast_….

keystringrequired

Where the bytes are held. Read-only, and never sent by you.

kindstringrequired

Follows from mimeType. It selects how a provider takes the file.

Allowed:imagevideo
mimeTypestringrequired

The type that finalize identified from the stored bytes. The Content-Type of the upload does not set it.

namestring | nullrequired

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.

organizationIdstringrequired

The organization that owns the Asset.

sizeBytesnumberrequired

Read from the stored object at finalize.

statusstringrequired

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.

Allowed:pendingreadyfailed
updatedAtnumber | nullrequired

When the Asset last changed, in milliseconds since the Unix epoch, UTC: at finalize, or at the last rename.

widthnumber | nullrequired

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.

registrationsobject[]required

Each Registration of this Asset, one for each advertiser, with its state. An empty array means that the Asset has no Registration.

Show properties
Array of object
advertiserIdstringrequired

The advertiser whose provider library gets the Asset.

assetIdstringrequired

The Asset that the Registration places.

createdAtnumberrequired

Milliseconds since the Unix epoch, UTC.

deletedAtnumber | nullrequired

Always null here. When a retry replaces a failed Registration, AdCrunch sets this time on the old one and answers it no more.

failureCodestring | nullrequired

Why AdCrunch refused the Registration before any provider call. Branch on this field, never on failureReason. not_found: your organization owns no advertiser of this provider with this id. provider_not_connected: the advertiser has no usable connection to the provider. Reconnect the provider, then register again. missing_write_access: the connection does not permit this kind of file. Reconnect the provider to grant it. null when the Registration did not fail, or when it failed at the provider.

Allowed:not_foundprovider_not_connectedmissing_write_access
failureReasonstring | nullrequired

Why the Registration failed, as a sentence: the words of the provider, or the words of AdCrunch. null unless status is failed.

idstringrequired

The id of the Registration, reg_….

organizationIdstringrequired

The organization that owns the Asset.

providerstringrequired

The provider that owns the advertiser.

Allowed:metagadstiktokxopenaisnapchatdv360
providerIdentifierstring | nullrequired

The id that the provider gave the file: a Meta image hash, or the id of the image or the video at the provider. null until the provider gives it, and null on a failed Registration. An image gets its id when the Registration becomes ready. A video gets its id earlier, while the Registration is running, because the provider gives the id before it has processed the file. Build a creative from a ready Registration only.

statusstringrequired

Video can stay running for several minutes while the provider processes it. That is normal, and not a failure.

Allowed:runningreadyfailed
updatedAtnumber | nullrequired

When the Registration last changed, in milliseconds since the Unix epoch, UTC. null until its first change.

uploadSessionIdstring | nullrequired

An in-flight provider upload session, where the protocol has one. null for every image.

workflowIdstringrequired

The durable execution that runs the Registration.

previewUrlstring | nullrequired

A signed, expiring link to the stored bytes. Minted for this answer, and valid for 15 minutes. Do not store it. null unless status is ready: a pending Asset has no validated bytes, and a failed Asset has no object.

400

The request does not match the schema of this operation: a field is missing or has the wrong type, or the body is not valid JSON. error is invalid_request, and issues names each field. Nothing was changed.

issuesobject[]required

One entry for each field that does not match.

Show properties
Array of object
instringrequired

The part of the request that holds the field.

Allowed:bodycookieheadersparamsquery
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

pathstringrequired

A JSON Pointer into that part of the request, such as /filename. An empty string is the whole part.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:invalid_request
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

401

No API key, or one that does not resolve. See the security scheme. error is unauthorized.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:unauthorized
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

402

The organization has no active subscription. An owner subscribes at paywallUrl. error is organization_unentitled.

paywallUrlstring<uri>required

The page where an owner of the organization subscribes. Show it to the person.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:organization_unentitled
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

403

The caller does not hold asset:read. error is forbidden.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:forbidden
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

404

No stored Asset with that id in this organization. error is not_found.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

Request
curl -X GET 'https://api.pr-1139.adcrunch.dev/assets/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "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,
  "registrations": [
    {
      "advertiserId": "acc_1203456789012345",
      "assetId": "ast_7c1e9a",
      "createdAt": 1790000121000,
      "deletedAt": null,
      "failureCode": null,
      "failureReason": null,
      "id": "reg_4b81d2",
      "organizationId": "org_3a7f10",
      "provider": "meta",
      "providerIdentifier": "23843178520310445",
      "status": "ready",
      "updatedAt": 1790000249000,
      "uploadSessionId": "1264871528937461",
      "workflowId": "reg_4b81d2"
    }
  ],
  "previewUrl": "https://b7f3c81a29d64e0fa5c3d1e8b0947265.r2.cloudflarestorage.com/assets/org_3a7f10/ast_7c1e9a?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20260922T104000Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=2f9a7c1e4b8d6035a1c7e2b94f0d38615c9a7e3d2b4f81c60d5a3e9b7f1c4028"
}