Dataczar
Browse helpers

API Reference / media / overlay-text

Overlay arbitrary text block.

Overlay arbitrary text block. Drop this helper wherever you want to overlay arbitrary text block with a single HTTP call. Send the documented inputs and the API streams back polished results you can hand directly to your users.

GETPOST/media/overlay-text

Visual example

Before
Before
After
After

Sample request

POST https://api.dataczar.com/media/overlay-text {"url":"https://images.unsplash.com/photo-1498050108023-c5249f4df085?auto=format&fit=crop&w=960&q=80","text":"Launch Day","position":"south"}

Parameters

Query Parameters

NameTypeDescription
urlstring
textstring
positionstring
font_sizeinteger
colorstring
backgroundstringOptional background box color (set blank for none).
formatstring
dryrunboolean

All helper calls accept your Dataczar key via the ak query parameter. Need one? Create or copy a key on Dataczar Connect and drop it into each request.

Responses

Status 200

Image transformed successfully.

"Binary image stream unless dryrun=true (JSON metadata)."

Examples

Request

"GET /img/overlay-text?url=https://example.com/a.jpg&dryrun=1"

Response

{
  "ok": true,
  "data": {
    "operation": "overlay-text"
  },
  "meta": {
    "dryrun": true
  }
}

Test Contracts

[
  {
    "name": "overlay-text_dryrun",
    "method": "GET",
    "params": {
      "url": "https://example.com/a.jpg",
      "dryrun": true
    },
    "expect": {
      "operation": "overlay-text"
    }
  }
]

File uploads (multipart form-data)

Attach PDFs or images as multipart fields. We'll fill in the field names for you.

Files
file

Query parameters

Equivalent curl
Grab your Dataczar API key
Every helper runs with the same simple API key. Sign in (or create a free Dataczar account) at Dataczar Connect to issue keys in seconds, then drop the key into any `ak=` parameter and start shipping.
Get your API keyBrowse helpers
Tip: reuse the same key across these helpers, or rotate keys per project from the Connect dashboard.