GIF.new API Documentation

Create personalized GIFs programmatically with our simple REST API

REST API

API Key Auth

Rate Limited

OpenAPI Specification

Quick Start

Get started with the GIF.new API in minutes

1. Get your API key

Go to Dashboard

2. Make your first request

curl -X GET "https://api.gif.new/api/templates" \
  -H "Authorization: Bearer YOUR_API_KEY"

Authentication

All API requests require authentication using Bearer tokens

Include your API key in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY

Security: Keep your API key secure and never expose it in client-side code. API keys provide full access to your account.

Rate Limits

API usage limits to ensure fair usage

Generation Requests

10/min

Per user account

Monthly Usage

Plan-based

Check /api/usage endpoint

Rate limit information is included in response headers: X-RateLimit-Remaining and X-RateLimit-Reset.

API Endpoints

Complete reference for all available endpoints

GET

/api/templates

List all your available templates with pagination support.

Query Parameters

pagePage number (default: 1)

limitItems per page (default: 10, max: 50)

searchSearch templates by name or description

Example Request

curl -X GET "https://api.gif.new/api/templates?page=1&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{
  "templates": [
    {
      "id": "tpl_abc123def456",
      "name": "Welcome Message",
      "description": "A friendly welcome template",
      "textOverlays": [
        { "text": "Welcome {{name}}!" }
      ],
      "generationCount": 42,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "totalCount": 5,
    "totalPages": 1
  }
}

Error Handling

Understanding API error responses

401

Unauthorized

Invalid or missing API key

404

Not Found

Template not found or doesn't belong to your account

429

Rate Limited

Rate limit exceeded or monthly usage limit reached

500

Server Error

Unexpected server error during processing

Error Response Format

{
  "error": "Rate limit exceeded. Please try again later."
}

Support

Get help with the API

Need help with the API? We're here to assist you:

📧 Email: [email protected]

📊 Dashboard: View your usage and manage API keys