CompressGIF Compressions API

The Compressions API from CompressGIF — 2 operation(s) for compressions.

GitHub OpenAPI

Operations 2

POST /api/v1/compressions Create a GIF compression job #
GET /api/v1/compressions/{id} Read job status and temporary download link #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/compressgif-net:compressgif-net-compressions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

compressgif-net-compressions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Compressgif Net Compressions API
  version: 1.0.0
  description: 'Operations tagged Compressions across 2 of this provider''s published API definitions: compressgif-net-openapi.json, compressgif-net-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://compressgif.net
security:
- bearerKey: []
- apiKey: []
tags:
- name: Compressions
paths:
  /api/v1/compressions:
    post:
      operationId: compressGif
      summary: Create a GIF compression job
      description: 'Free: up to 5,000,000 bytes, 10 submissions/minute, 2 outstanding jobs. Developer: up to 20,000,000 bytes, 60/minute, 20 outstanding jobs. Each attempt has a total 60-second processing budget.'
      parameters:
      - in: header
        name: Idempotency-Key
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 128
        description: Account-scoped retry key. Same key with a different request returns 409.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - sourceUrl
              additionalProperties: false
              properties:
                sourceUrl:
                  type: string
                  format: uri
                  pattern: ^https://
                options:
                  $ref: '#/components/schemas/Options'
          multipart/form-data:
            schema:
              type: object
              required:
              - file
              properties:
                file:
                  type: string
                  format: binary
                options:
                  type: string
                  description: JSON-encoded Options object.
                  example: '{"mode":"target","targetBytes":1000000}'
      responses:
        '200':
          description: Idempotent replay; no additional credits reserved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '202':
          description: Accepted; credits reserved until completion.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '400':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Compressions
    servers:
    - url: https://compressgif.net
  /api/v1/compressions/{id}:
    get:
      operationId: getCompression
      summary: Read job status and temporary download link
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Download links last 15 minutes; file access ends after 24 hours.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '400':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Machine-readable error. Respect Retry-After when present.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Compressions
    servers:
    - url: https://compressgif.net
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
            message:
              type: string
    Job:
      type: object
      properties:
        id:
          type: string
        pool:
          type: string
          enum:
          - free
          - developer
        status:
          type: string
          enum:
          - queued
          - processing
          - succeeded
          - failed
          - canceled
        inputBytes:
          type: integer
        outputBytes:
          type:
          - integer
          - 'null'
        credits:
          type: integer
        targetMet:
          type:
          - boolean
          - 'null'
        appliedSettings:
          type:
          - object
          - 'null'
        result:
          type:
          - object
          - 'null'
          properties:
            downloadUrl:
              type: string
              format: uri
            expiresInSeconds:
              type: integer
              minimum: 0
              maximum: 900
        error:
          type:
          - object
          - 'null'
          properties:
            code:
              type: string
            message:
              type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        expiresAt:
          type: string
          format: date-time
    Options:
      type: object
      additionalProperties: false
      properties:
        mode:
          type: string
          enum:
          - quality
          - size
          - target
          default: quality
        targetBytes:
          type: integer
          minimum: 1
          description: Required in target mode; decimal bytes.
        colors:
          enum:
          - auto
          - 64
          - 128
          - 256
        lossyLevel:
          type: integer
          minimum: 0
          maximum: 200
        width:
          type: integer
          minimum: 1
          maximum: 4096
          description: Optional explicit resize width; omitted preserves dimensions.
      allOf:
      - if:
          properties:
            mode:
              const: target
          required:
          - mode
        then:
          required:
          - targetBytes
  securitySchemes:
    bearerKey:
      type: http
      scheme: bearer
      bearerFormat: API key
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
x-refined-from:
- compressgif-net-openapi.json
- compressgif-net-openapi.yml
x-credit-tiers:
- maxBytes: 5000000
  normalCredits: 1
- maxBytes: 20000000
  normalCredits: 2
x-target-mode-multiplier: 2