Rename an Asset

Renames an Asset. The name is what the console shows and what a provider receives at future registrations; sending an empty name clears it back to the original filename. A Registration already made keeps the name it was given. An Asset belonging to another organization is reported as missing, so the surface cannot be used to discover that an id is real.

PATCH/assets/{id}

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

idstringrequired

matches ^(ast_)[\s\S]{0,}$

Request body

requiredapplication/json

namestringrequired

The name to show. Send an empty string to clear it back to the original filename.

max length 255

Responses

200

The Asset, with its new name.

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, where that is known. null for an image.

filenamestringrequired

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

heightnumber | nullrequired

idstringrequired

keystringrequired

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

kindstringrequired

Read from the stored bytes at finalize, and never from what you declared. It selects how a provider takes the file.

Allowed:imagevideo

mimeTypestringrequired

Read from the stored object at finalize.

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

sizeBytesnumberrequired

Read from the stored object at finalize.

statusstringrequired

ready once the bytes have been inspected. A pending Asset is a reservation whose bytes have not arrived, and no operation here answers one.

Allowed:pendingready

updatedAtnumber | nullrequired

Milliseconds since the Unix epoch, UTC.

widthnumber | nullrequired

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

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.

422

The request did not match this operation’s schema. This is the framework’s own shape, not the error/message one.

errorsobject[]required

One entry per failing field.

foundanyrequired

What was sent.

messagestringrequired

onstringrequired

Which part of the request failed: body, query or params.

propertystringrequired

The field that failed.

typestringrequired

Allowed:validation

Request

curl -X PATCH "https://api.adcrunch.dev/assets/string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'

const response = await fetch("https://api.adcrunch.dev/assets/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\"\n}"
});

import requests

response = requests.patch(
    "https://api.adcrunch.dev/assets/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\"\n}",
)

Response

{
  "contentHash": "string",
  "createdAt": 0,
  "createdBy": "string",
  "deletedAt": 0,
  "durationMs": 0,
  "filename": "string",
  "height": 0,
  "id": "string",
  "key": "string",
  "kind": "image",
  "mimeType": "string",
  "name": "string",
  "organizationId": "string",
  "sizeBytes": 0,
  "status": "pending",
  "updatedAt": 0,
  "width": 0
}

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

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

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

{
  "errors": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "found": null,
  "message": "string",
  "on": "string",
  "property": "string",
  "type": "validation"
}