MediaReplace a file

Replace a file

Swaps in a new version of a file, sent as multipart/form-data or imported from a public HTTPS URL. The new file must be the same type as the original. The URL stays the same, so every page that uses the file shows the new version without an edit. An image can take up to a minute to refresh. Requires editor or admin role.

curl -X POST "https://api.documentationai.app/api/v1/media/123e4567-e89b-12d3-a456-426614174000/replace" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "url": "https://example.com/setup-diagram.png"
}'
{
  "media": {
    "id": "4c1d8a2e-7b3f-4f0a-9d6e-2a5b8c7e1f03",
    "name": "setup-diagram.png",
    "kind": "image",
    "mimeType": "image/png",
    "sizeBytes": 184233,
    "url": "https://blob-cdn.documentation.ai/.../setup-diagram.png",
    "altText": "Setup steps diagram",
    "width": 1440,
    "height": 900,
    "durationSeconds": 42,
    "pageCount": 25,
    "posterUrl": "example_string",
    "createdAt": "2026-09-17T10:00:00.000Z",
    "updatedAt": "2026-09-17T10:00:00.000Z",
    "snippet": "<Image src="https://blob-cdn.documentation.ai/.../setup-diagram.png" alt="Setup steps diagram" />"
  }
}
POST
/media/{mediaId}/replace
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...

API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...
path
mediaIdstring
Required

The file's id, from GET /media or an upload result

Format: uuid
Content-Typestring
Required

The media type of the request body

Options: multipart/form-data, application/json
filestring
Required

The new version of the file

Format: binary
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...

Path Parameters

mediaIdstring
Required

The file's id, from GET /media or an upload result

Body

urlstring
Required

HTTPS URL of the new version

Example:
https://example.com/setup-diagram.png

Responses

mediaobject

A file in the media library.