Update alt text

Changes a file's alt text. For an image, screen readers read it. For any other file, it is the link text the web editor uses the next time someone inserts the file; links already on pages are not rewritten. Requires editor or admin role.

curl -X PATCH "https://api.documentationai.app/api/v1/media/123e4567-e89b-12d3-a456-426614174000" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "altText": "Setup steps diagram"
}'

import requests
import json

url = "https://api.documentationai.app/api/v1/media/123e4567-e89b-12d3-a456-426614174000"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
  "altText": "Setup steps diagram"
}

response = requests.patch(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://api.documentationai.app/api/v1/media/123e4567-e89b-12d3-a456-426614174000", {
  method: "PATCH",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
},
  body: JSON.stringify({
  "altText": "Setup steps diagram"
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "altText": "Setup steps diagram"
}`)

    req, err := http.NewRequest("PATCH", "https://api.documentationai.app/api/v1/media/123e4567-e89b-12d3-a456-426614174000", 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')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
  "altText": "Setup steps diagram"
}'

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"
    }
  ]
}