POST/api/v1/ai/pages/{slug}/alt-text

Suggest alt text

Suggests alt text for one of the images in a page you can edit. Nothing is saved.

API token requiredOr edit secret60 per minute per IP

Guide: AI in pages

Code samples and Try it

Path parameters

slugstringRequired
The document's address: the part after markdrop.in/.

Headers

X-Edit-Secretstring
The document's edit secret (sk_…), for a document published without an account. See Edit key.

Request body

application/json, required

asset_idstringRequired
The image's id: the <id> of asset:<id> in the page. Up to 300 characters.

Responses

200OK.
401No token, or the token is revoked or mistyped.
422The request didn't validate. detail lists each problem, with where it is (loc) and why (msg).
429Too many requests from your IP address. Wait the seconds in Retry-After.
501Image descriptions aren't available.

bash

curl -X POST https://api.markdrop.in/api/v1/ai/pages/k3x9q2m/alt-text \
  -H "Authorization: Bearer $MARKDROP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"asset_id":"ASSET_ID"}'

javascript

const res = await fetch("https://api.markdrop.in/api/v1/ai/pages/k3x9q2m/alt-text", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MARKDROP_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "asset_id": "ASSET_ID"
  }),
});
const data = await res.json();

python

import os

import requests

r = requests.post(
    "https://api.markdrop.in/api/v1/ai/pages/k3x9q2m/alt-text",
    headers={"Authorization": f"Bearer {os.environ['MARKDROP_TOKEN']}"},
    json={"asset_id": "ASSET_ID"},
)
r.raise_for_status()
print(r.json())

Try it

API token

Kept in this tab only, and sent only to the API. Create a token

slugrequired

X-Edit-Secret

asset_idrequired

Your request

curl -X POST https://api.markdrop.in/api/v1/ai/pages/k3x9q2m/alt-text \
  -H "Authorization: Bearer $MARKDROP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"asset_id":"ASSET_ID"}'

This calls the live API as you. Changes are real.

I understand, send real requests from this page

Tick the box above to send. Or copy the command and run it in a terminal.

Did this page help?