---
title: "Get your AI image allowance"
method: GET
path: "/media/generate-image"
tags: ["Media library"]
---

# Get your AI image allowance

`GET /media/generate-image`

## Request

- Base URL: `https://www.sociahive.com/api/v1`
- URL: `https://www.sociahive.com/api/v1/media/generate-image`
- Auth: one of:
  - API key in header `X-API-Key`
  - OAuth 2 (authorization code, authorization URL `/api/oauth/authorize`, token URL `/api/oauth/token`, scopes: `uploads:write`)

How many AI images you have used this month, your plan's limit and when it resets. Behind SCHEDULER_COMPOSER_IMAGE_GEN.

## Response `200`

The allowance

- object
  - `allowance` AiImageAllowance, required
    - `used` integer, required
    - `limit` integer, nullable, required: Images per month on your plan; null is unlimited.
    - `remaining` integer, nullable, required: Null is unlimited.
    - `resetAt` string, date-time, required: When the count starts again.

## Other responses

- `400`: Bad request — invalid parameters
- `401`: Authentication required — provide X-API-Key or Bearer token
- `403`: Insufficient scope for this operation
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/sociahive/apis/sociahive-api.md) · [All operations](https://skmtc.dev/sociahive/apis/sociahive-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sociahive/apis/sociahive-api/revisions/791b8548d288?raw)