Start a document upload

Reserves a document on a Brand, and is the first of the three steps of an upload. The answer gives a URL with a short life. PUT the bytes to that URL with their Content-Type, then call finalize. The bytes do not go through this API. AdCrunch accepts PDF, GIF, JPEG, PNG and WebP. It refuses SVG, because a stored document is served from an adcrunch.dev host and an SVG carries script.

POST/context/brands/{slug}/documents

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

slugstringrequired

Request body

requiredapplication/json

content_typestringrequired

The type you are about to upload. Re-checked against the stored object at finalize — this is only a declaration.

filenamestringrequired

min length 1 · max length 255

Responses

201

A reserved destination, valid for expiresInSeconds. PUT the bytes to uploadUrl, then call finalize with documentId. The URL itself gives write access: anybody holding it can write that one object until it lapses. The Document does not exist for any reader until finalize succeeds.

documentIdstringrequired

Pass this to the finalize call.

expiresInSecondsnumberrequired

How long uploadUrl stays valid. Reserve again if it lapses.

uploadUrlstringrequired

A short-lived presigned URL. PUT the bytes here.

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.

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 Brand with that slug. 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.

415

That media type is not accepted. error is unsupported_type, and allowed names every type that is. This is the declared type; the stored object is checked again at finalize.

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.pr-701.adcrunch.dev/context/brands/string/documents" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "content_type": "application/pdf",
  "filename": "acme-brand-guidelines.pdf"
}'

const response = await fetch("https://api.pr-701.adcrunch.dev/context/brands/string/documents", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"content_type\": \"application/pdf\",\n  \"filename\": \"acme-brand-guidelines.pdf\"\n}"
});

import requests

response = requests.post(
    "https://api.pr-701.adcrunch.dev/context/brands/string/documents",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"content_type\": \"application/pdf\",\n  \"filename\": \"acme-brand-guidelines.pdf\"\n}",
)

Response

{
  "documentId": "doc_5e2b41",
  "expiresInSeconds": 900,
  "uploadUrl": "https://a1b2c3d4e5f6.r2.cloudflarestorage.com/documents/org_3a7f10/doc_5e2b41?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=900&X-Amz-Signature=8f1c…"
}

{
  "issues": [
    {
      "in": "body",
      "message": "string",
      "path": "string"
    }
  ],
  "error": "invalid_request",
  "message": "string"
}

{
  "error": "unauthorized",
  "message": "string"
}

{
  "error": "forbidden",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

{
  "allowed": [
    "string"
  ],
  "error": "unsupported_type",
  "message": "string"
}