API Reference

Build, integrate, and scale with Banner.codes REST API. Every endpoint, parameter, and response documented.

Base URL

https://api.banner.codes/v1

All requests must be made over HTTPS. Responses are in JSON format.

Authentication

Most endpoints require an API key. Include it in the `Authorization` header:

Authorization: Bearer YOUR_API_KEY

You can manage API keys in your dashboard.

Endpoints

POST/v1/images API Key required

Generate a banner image from a template and data.

GET/v1/images/{id} API Key required

Retrieve metadata of a generated image.

GET/v1/templates Optional

List all available templates.

POST/v1/keys User authentication required

Create a new API key.

DELETE/v1/keys/{id} User authentication required

Revoke an API key.

Quick Example

Generate a banner

curl -X POST https://api.banner.codes/v1/images \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "template": "social-share",
    "data": {
      "title": "Hello World",
      "subtitle": "Generated with Banner.codes"
    }
  }'

Returns a JSON with the image URL and metadata. See the full documentation for all options.

This is a summary. For the complete API reference, visit our dedicated documentation portal.