Page metadata

curl -X POST "$DOATHING_API/v1/markup/extract-metadata" \
  -H "x-api-key: $DOATHING_KEY" \
  -H "content-type: application/json" \
  -d '{"text": "<title>A Page</title><meta property=\"og:image\" content=\"/c.png\">", "base_url": "https://example.test/"}'

Title, description, OpenGraph and Twitter card fields — what a link preview would show.

Extract title, description, canonical URL, OpenGraph and Twitter card metadata from HTML.

Input

Send either a text string or a file object. A file is decoded as UTF-8 and must be one of text/html, text/plain.

Response

The result carries your remaining balance alongside it, so you can track spend without a second call.

{
  "title": "A Page",
  "description": null,
  "opengraph": {
    "image": "https://example.test/c.png"
  },
  "twitter": {},
  "request_id": "37f01edb-0163-42a1-ac51-0acaef979800",
  "credits_remaining": 96
}

Cost

2 credits per call, whether it is run from the site or from the API — the credential differs, the price does not. A new account starts with 20 credits.

A rejected request still costs a credit: the authorizer decrements before the tool validates. A call rejected for a missing or invalid key is free.