Happytails.ai /DevelopersAPI v1
API reference

Alt text generator

Local BLIP image descriptions.

POST/api/v1/tools/alt-text-generator/run

Base URL: https://happytails.ai · public API not connected

Overview

Local BLIP image descriptions. Suggestions can be wrong and do not include surrounding page context. Review and edit before publishing.

All API requests process supplied data on the server. File handling and privacy.

Request parameters

Send a JSON object. Unknown properties are rejected. Omitted options use the defaults below; enter numbers and booleans as JSON values, not quoted text.

No text input is needed. Use the settings and files below.

Files

Accepted formats: .png,.jpg,.jpeg,.webp. Up to 1 file(s), totaling 20 MiB decoded.

Each files entry requires name and padded base64. Optional mime describes the content; optional bytes must equal its decoded length. Filenames cannot contain paths. File URLs are not accepted. See uploading and saving files.

Options

No options are needed. Omit options or send an empty object.

Success response

HTTP 200 returns tool and result. Text is in result.text; parsed JSON may also appear in result.data. Generated files are in result.files with name, mime, bytes and base64. Decode the bytes before saving. Empty file arrays and null text are valid for operations returning another result type.

Complete output schema
{
  "type": "object",
  "required": [
    "tool",
    "result"
  ],
  "properties": {
    "tool": {
      "type": "string"
    },
    "result": {
      "type": "object",
      "required": [
        "text",
        "files"
      ],
      "properties": {
        "text": {
          "type": [
            "string",
            "null"
          ]
        },
        "data": {
          "description": "Parsed JSON when the textual result is JSON."
        },
        "name": {
          "type": "string"
        },
        "mime": {
          "type": "string"
        },
        "files": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "name",
              "mime",
              "bytes",
              "base64"
            ],
            "properties": {
              "name": {
                "type": "string"
              },
              "mime": {
                "type": "string"
              },
              "bytes": {
                "type": "integer"
              },
              "base64": {
                "type": "string",
                "contentEncoding": "base64"
              }
            }
          }
        }
      }
    }
  }
}

Limits and failures

Limits below are enforced by this endpoint. Additional format, page, duration and model limits in the behavior notes also apply. Browser UI limits can differ from API limits.

request_bytes
31457280
input_characters
1000000
files_bytes
20971520
max_files
1
timeout_seconds
90

Invalid requests return an error object with code and message. Read HTTP statuses, retries, timeouts and concurrency. Execution is synchronous and results are returned in the response.

Complete request schema

Expand the JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "input": {
      "type": "string",
      "maxLength": 1000000,
      "default": "",
      "description": "Plain text input. File tools use files instead unless otherwise documented."
    },
    "options": {
      "type": "object",
      "additionalProperties": false,
      "properties": {}
    },
    "files": {
      "type": "array",
      "maxItems": 1,
      "items": {
        "type": "object",
        "required": [
          "name",
          "base64"
        ],
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 200,
            "description": "Filename only, no path."
          },
          "mime": {
            "type": "string",
            "maxLength": 150
          },
          "bytes": {
            "type": "integer",
            "minimum": 0,
            "description": "Optional decoded byte count; must match content if supplied."
          },
          "base64": {
            "type": "string",
            "contentEncoding": "base64",
            "description": "File bytes as padded base64. Use the tool-specific limits.files_bytes value for the total decoded input size."
          }
        }
      }
    }
  }
}

For browser automation, use the central WebMCP guidance and discover the tools actually exposed by the browser.

Request example
import json
from urllib.request import Request, urlopen
import base64
from pathlib import Path

source = Path("input.png")

payload = json.loads('{"options": {}}')
payload["files"] = [{
    "name": source.name,
    "base64": base64.b64encode(source.read_bytes()).decode("ascii")
}]

request = Request(
    "https://happytails.ai/api/v1/tools/alt-text-generator/run",
    data=json.dumps(payload).encode(),
    headers={"Content-Type": "application/json"},
)
with urlopen(request, timeout=200) as response:
    result = json.load(response)
    print(result)

Python and JavaScript read your local file and encode it as Base64. Replace the input filename and API origin.

200 OK · response structure
{
  "tool": "alt-text-generator",
  "result": {
    "text": null,
    "files": [
      {
        "name": "result",
        "mime": "application/octet-stream",
        "bytes": 0,
        "base64": "BASE64_OUTPUT_BYTES"
      }
    ]
  }
}

Illustrative envelope. Actual text, filename, MIME type and bytes depend on the result. See the complete output schema.

400 Bad Request
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Unknown request property. See the tool input schema."
  }
}