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"
}'
import requests
import json
url = "https://api.documentationai.app/api/v1/media/123e4567-e89b-12d3-a456-426614174000/replace"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"url": "https://example.com/setup-diagram.png"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.documentationai.app/api/v1/media/123e4567-e89b-12d3-a456-426614174000/replace", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"url": "https://example.com/setup-diagram.png"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"url": "https://example.com/setup-diagram.png"
}`)
req, err := http.NewRequest("POST", "https://api.documentationai.app/api/v1/media/123e4567-e89b-12d3-a456-426614174000/replace", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.documentationai.app/api/v1/media/123e4567-e89b-12d3-a456-426614174000/replace')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"url": "https://example.com/setup-diagram.png"
}'
response = http.request(request)
puts response.body
{
"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" />"
}
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Error",
"message": "The file is larger than your plan allows for its kind, for example `File size exceeds your plan's limit of 10MB.`",
"code": 413
}
{
"error": "Error",
"message": "The file type is not accepted, the file's contents do not match its extension, or an SVG contains a script or embedded content",
"code": 415
}
{
"error": "Too Many Requests",
"message": "Rate limit exceeded. Please try again later",
"code": 429,
"retryAfter": 3600
}
{
"error": "Error",
"message": "Your organization's storage quota is full. Free space by deleting unused files, or upgrade your plan.",
"code": 507
}
/media/{mediaId}/replaceTarget server for requests. Edit to use your own host.
API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...
Authorization: Bearer dai_...The file's id, from GET /media or an upload result
The media type of the request body
The new version of the file
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...
Path Parameters
The file's id, from GET /media or an upload result
Body
Responses
A file in the media library.