Skip to content
AdCrunch
Esc
navigateopen⌘Jpreview

Finalize a document upload

Completes a reserved document after you send the bytes. AdCrunch reads the size and the content type from the stored file. It does not take them from you, because the upload URL applies no rules of its own. This call is the only point of validation.

POST/context/brands/{slug}/documents/{documentId}/finalize
Authorization
AuthorizationBearer token · headerrequired

Send Authorization: Bearer <credential>. Two credentials work.

An API key (acr_…) is what a server integration uses. Create one in the AdCrunch console under Settings → API keys — see https://docs.adcrunch.dev/account/api-keys. A key is bound to the organization that was active when you created it, and it keeps acting on that organization whatever you do later. It carries the permissions of the member who created it.

A session issued by the AdCrunch sign-in flow also works, which is how the console calls this service from the browser.

Either way the organization comes from the credential. There is no organization parameter.

Path parameters
documentIdstringrequired
matches ^doc_[\s\S]{0,}$
slugstringrequired
Responses
200

The Document, now readable. sizeBytes and mimeType are read off the stored object rather than taken from your declaration.

createdAtnumberrequired

Milliseconds since the Unix epoch, UTC.

filenamestringrequired
idstringrequired
mimeTypestringrequired
namestringrequired

The display name. Falls back to the filename.

sizeBytesnumberrequired

Read off the stored object at finalize, never from the client.

targetIdstringrequired
targetTypestringrequired

What the Document is attached to. brand today.

urlstringrequired
401

No credential, or one that does not resolve. Send an API key or a session. 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.

403

The caller does not hold brand: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.

404

No reservation with that id on this Brand. 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.

409

The reservation exists but no bytes have arrived. error is no_object. PUT to the uploadUrl first.

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 stored object is over the limit. error is too_large.

limitBytesnumberrequired
sizeBytesnumberrequired

What the stored object actually measured.

errorstringrequired

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

Allowed:too_large
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

The stored object is not an accepted type, whatever was declared at reservation. error is unsupported_type, and the object has been discarded.

allowedstring[]required

Every media type this API accepts as a Document.

errorstringrequired

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

Allowed:unsupported_type
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.adcrunch.dev/context/brands/string/documents/string/finalize" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "createdAt": 0,
  "filename": "string",
  "id": "string",
  "mimeType": "string",
  "name": "string",
  "sizeBytes": 0,
  "targetId": "string",
  "targetType": "string",
  "url": "string"
}