Upload media
Uploads 1 to 10 files in one multipart/form-data request. Each file gets the same checks as an upload in the web editor: a supported type, contents that match the extension, a safe SVG, your plan's size limit, and your storage quota. The response has one result per file, so one failed file does not fail the others. A file that is already in the library is reused. If another file already has the same name, the new file gets a number added, such as diagram-2.png. Requires editor or admin role.
curl -X POST "https://api.documentationai.app/api/v1/media" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
--form files=["example_string"]
import requests
import json
url = "https://api.documentationai.app/api/v1/media"
headers = {
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"files": "["example_string"]"
}
response = requests.post(url, headers=headers, data=data)
print(response.json())
const formData = new FormData();
formData.append("files", "["example_string"]");
const response = await fetch("https://api.documentationai.app/api/v1/media", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: formData
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"mime/multipart"
)
func main() {
body := &bytes.Buffer{}
writer := multipart.NewWriter(body)
writer.WriteField("files", "["example_string"]")
writer.Close()
req, err := http.NewRequest("POST", "https://api.documentationai.app/api/v1/media", body)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
req.Header.Set("Content-Type", writer.FormDataContentType())
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')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.set_form([
["files", "["example_string"]"]
], 'multipart/form-data')
response = http.request(request)
puts response.body
{
"results": [
{
"source": "https://example.com/setup-diagram.png",
"status": "added",
"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": "File size exceeds your plan's limit of 10MB.",
"statusCode": 413
}
]
}
{
"results": [
{
"source": "https://example.com/setup-diagram.png",
"status": "added",
"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": "File size exceeds your plan's limit of 10MB.",
"statusCode": 413
}
]
}
{
"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": "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
Target 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 media type of the request body
The files to upload. Repeat the files field once for each 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_...
Body
The files to upload. Repeat the files field once for each file.