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

Create an Asset from raw bytes

Creates an Asset in one of two ways. The Content-Type of the request picks one.

Raw bytes. The body is the file. AdCrunch answers 201 with a ready Asset. Do not use multipart/form-data.

curl --data-binary @ad.png \
  -H "Authorization: Bearer $ADCRUNCH_API_KEY" \
  "https://api.adcrunch.dev/assets?filename=ad.png"

The bytes stream into storage. AdCrunch identifies the type from the bytes, and the Content-Type is only a hint. A file that AdCrunch refuses leaves no object and no Asset.

The request needs a Content-Length. A body with no length answers 411.

Size. This route takes a body up to 95 MB. Over that, it answers 413 with error set to use_upload_url: reserve an upload with POST /assets/uploads, and PUT the file to the URL. A body over the limit of the Cloudflare plan of the domain, 100 MB at the lowest, never reaches AdCrunch. Cloudflare refuses it at the edge with its own 413 page, with no use_upload_url. Send a large video to POST /assets/uploads.

Import from a URL. The JSON body needs a Content-Length and is at most 8 KB. Send Content-Type: application/json with { "sourceUrl": "https://...", "name": "..." }. sourceUrl must be an https URL on port 443, else the answer is 400 with error set to invalid_url. Its host must be a public name: an IP address, a local or private host, or an AdCrunch domain (adcrunch.dev and its subdomains) answers 400 with error set to source_not_allowed. AdCrunch answers 202 with a pending Asset, and a Workflow fetches the file. Poll GET /assets/{id} until status is ready or failed. A failed Asset has a failureCode: source_unreachable (the source did not answer, answered with an error, or sent the file in part), source_length_unknown (the source sent no Content-Length), too_large, unsupported_type or unreadable. The import does not follow a redirect to a URL that is not https.

curl -X POST \
  -H "Authorization: Bearer $ADCRUNCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sourceUrl":"https://example.com/ad.png"}' \
  "https://api.adcrunch.dev/assets"
POST/assets
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.

Query parameters
filenamestring
min length 1 · max length 255
namestring
max length 255
Request body
requiredapplication/json

The raw bytes of the file with any Content-Type except application/json, or a JSON import { sourceUrl, name? }.

namestring

The name to show in place of the filename.

max length 255
sourceUrlstringrequired

An https URL of an image or a video.

max length 2048
Responses
201

The stored Asset, already ready.

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.

202

The import started. The Asset is pending. Poll GET /assets/{id} until it is ready or failed.

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.

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:write. 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.

411

The request has no Content-Length. error is length_required. This holds for a raw body and for a JSON body.

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.

413

The body is too large. error names why:

  • use_upload_url: the body is over 95 MB. Use POST /assets/uploads.
  • payload_too_large: the JSON body of an import is over 8 KB.
  • too_large: the file is over the limit for its kind, 30 MB for an image and 4 GB for a video. AdCrunch stored nothing.

A body over the limit of the Cloudflare plan of the domain gets a 413 from Cloudflare, before AdCrunch runs. That answer has no error code.

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.

415

AdCrunch refused the file. error names why:

  • unsupported_type: the bytes are no type that AdCrunch accepts.
  • unreadable: the file ends before its header does.
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 POST 'https://api.pr-1139.adcrunch.dev/assets' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "sourceUrl": "https://example.com/ad.png"
}'
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": null,
  "organizationId": "org_3a7f10",
  "sizeBytes": 24117248,
  "status": "ready",
  "updatedAt": 1790000120000,
  "width": 1080
}