ImageRouter

https://docs.imagerouter.io
Admin
ImageRouter is a unified API platform that enables developers to generate images, videos, and text...
Tokens:24,685
Snippets:161
Trust Score:5
Update:4 hours ago
Show doc for...
Tokens:
Raw
### Response Example for Get remaining credits

Source: http://docs.imagerouter.io/api-reference/credits/

Example JSON response showing remaining credits, credit usage, and total deposits.

```json
{
    "remaining_credits": "25.5000",
    "credit_usage": "4.5000",
    "total_deposits": "30.0000"
}
```

--------------------------------

### Response Example for Detailed Usage by API Key

Source: http://docs.imagerouter.io/api-reference/credits/

Example JSON response showing credit usage breakdown per API key, including fields like spend_limit, period_spend, and expires_at.

```json
{
    "remaining_credits": "25.5000",
    "credit_usage": "4.5000",
    "total_deposits": "30.0000",
    "usage_by_api_key": [
        {
            "api_key_id": "d9eb93dc-56b1-4216-91b5-a44944508bbc",
            "api_key_name": "Production Key",
            "credit_usage": "4.2000",
            "total_requests": 150,
            "created_at": "2023-10-01T12:00:00.000Z",
            "is_active": true,
            "spend_limit": "5.0000",
            "spend_limit_period": "month",
            "period_spend": "1.2000",
            "period_start": "2026-05-01T00:00:00.000Z",
            "expires_at": "2027-01-01T00:00:00.000Z"
        },
        {
            "api_key_id": "temp_jwt",
            "api_key_name": "Temporary web token (imagerouter.io)",
            "credit_usage": "0.0300",
            "total_requests": 45,
            "created_at": null,
            "is_active": false,
            "spend_limit": null,
            "spend_limit_period": null,
            "period_spend": "0.0300",
            "period_start": null,
            "expires_at": null
        }
    ]
}
```

--------------------------------

### Get remaining credits - Python

Source: http://docs.imagerouter.io/api-reference/credits/

Python requests example to retrieve account credit information. Requires an API key in the Authorization header.

```python
import requests

url = "https://api.imagerouter.io/v1/credits"
headers = {
  "Authorization": "Bearer YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### Get remaining credits - JavaScript

Source: http://docs.imagerouter.io/api-reference/credits/

JavaScript fetch example to retrieve account credit information. Requires an API key in the Authorization header.

```javascript
const url = 'https://api.imagerouter.io/v1/credits'
const response = await fetch(url, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
})
const data = await response.json()
console.log(data)
```

--------------------------------

### Detailed Usage by API Key - JavaScript

Source: http://docs.imagerouter.io/api-reference/credits/

JavaScript fetch example to retrieve credit usage breakdown per API key using the by_api_key=true query parameter.

```javascript
const url = 'https://api.imagerouter.io/v1/credits?by_api_key=true'
const response = await fetch(url, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
})
const data = await response.json()
console.log(data)
```

--------------------------------

### Detailed Usage by API Key - Python

Source: http://docs.imagerouter.io/api-reference/credits/

Python requests example to retrieve credit usage breakdown per API key using the by_api_key=true query parameter.

```python
import requests

url = "https://api.imagerouter.io/v1/credits"
params = {
  "by_api_key": "true"
}
headers = {
  "Authorization": "Bearer YOUR_API_KEY"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
```

--------------------------------

### Chat Completion - Python

Source: https://docs.imagerouter.io/

Python example using the OpenAI SDK with a custom base_url to perform a chat completion. Replace YOUR_API_KEY with your actual key. Uses the openai/gpt-4o-mini model.

```python
from openai import OpenAI

client = OpenAI(
  api_key="YOUR_API_KEY",
  base_url="https://api.imagerouter.io/v1/openai",
)

completion = client.chat.completions.create(
  model="openai/gpt-4o-mini",
  messages=[{"role": "user", "content": "Hello!"}],
)

print(completion.choices[0].message.content)
```

--------------------------------

### List normal API keys with Management key (JavaScript)

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

Uses fetch to GET /v1/api-keys with Authorization header. Logs the data array of key metadata (no secrets).

```javascript
const response = await fetch('https://api.imagerouter.io/v1/api-keys', {
  headers: { 'Authorization': 'Bearer YOUR_MANAGEMENT_API_KEY' }
})
const { data } = await response.json()
console.log(data) // array of key metadata (no secrets)
```

--------------------------------

### Text to Image - Python

Source: https://docs.imagerouter.io/

Python requests example to generate an image using the ImageRouter API. Replace YOUR_API_KEY and YOUR_PROMPT with actual values. Uses the test/test model.

```python
import requests

url = "https://api.imagerouter.io/v1/openai/images/generations"
payload = {
  "prompt": "YOUR_PROMPT",
  "model": "test/test"
}
headers = {
  "Authorization": "Bearer YOUR_API_KEY"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())
```

--------------------------------

### Text to Image - JavaScript

Source: https://docs.imagerouter.io/

JavaScript fetch example to generate an image using the ImageRouter API. Replace YOUR_API_KEY and YOUR_PROMPT with actual values. Uses the test/test model.

```javascript
const url = 'https://api.imagerouter.io/v1/openai/images/generations';
const payload = {
  prompt: 'YOUR_PROMPT',
  model: 'test/test'
};

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(payload)
});

const data = await response.json();
console.log(data);
```

--------------------------------

### Generate images with JSON (JavaScript)

Source: http://docs.imagerouter.io/api-reference/image-generation/

JavaScript fetch example for the /v1/openai/images/generations endpoint. Shows text-to-image payload and commented lines for image-to-image with a URL or array of URLs.

```javascript
const url = 'https://api.imagerouter.io/v1/openai/images/generations'

// Text-to-Image
const payload = {
  prompt: 'YOUR_PROMPT',
  model: 'test/test',
  quality: 'auto',
  size: 'auto',
  response_format: 'url',
  output_format: 'webp'
}

// Image-to-Image — pass a URL or data URI string
// payload.image = 'https://example.com/your_image.jpg'
// payload.image = ['https://example.com/img1.jpg', 'https://example.com/img2.jpg']

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(payload)
})

const data = await response.json()
console.log(data)
```

--------------------------------

### Chat Completion - JavaScript

Source: https://docs.imagerouter.io/

JavaScript example using the OpenAI SDK with a custom baseURL to perform a chat completion. Replace YOUR_API_KEY with your actual key. Uses the openai/gpt-4o-mini model.

```javascript
import OpenAI from 'openai';

const client = new OpenAI({
apiKey: 'YOUR_API_KEY',
baseURL: 'https://api.imagerouter.io/v1/openai',
});

const completion = await client.chat.completions.create({
model: 'openai/gpt-4o-mini',
messages: [{ role: 'user', content: 'Hello!' }],
});

console.log(completion.choices[0].message.content);
```

--------------------------------

### Generate images with JSON (Python)

Source: http://docs.imagerouter.io/api-reference/image-generation/

Python requests example for the /v1/openai/images/generations endpoint. Shows text-to-image payload and commented lines for image-to-image with a URL or list of URLs.

```python
import requests

url = "https://api.imagerouter.io/v1/openai/images/generations"
headers = {
  "Authorization": "Bearer YOUR_API_KEY"
}

# Text-to-Image
payload = {
  "prompt": "YOUR_PROMPT",
  "model": "test/test",
  "quality": "auto",
  "size": "auto",
  "response_format": "url",
  "output_format": "webp"
}

# Image-to-Image — pass a URL or data URI string
# payload["image"] = "https://example.com/your_image.jpg"
# payload["image"] = ["https://example.com/img1.jpg", "https://example.com/img2.jpg"]

response = requests.post(url, json=payload, headers=headers)
print(response.json())
```

--------------------------------

### List API keys response example (200 OK)

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

Response for listing normal API keys. Contains an array of key metadata objects, each with id, name, created_at, is_active, is_management, spend_limit, spend_limit_period, and expires_at. Secret key values are never returned.

```json
{
    "data": [
        {
            "id": "8a5cf3a2-7b1e-4d6e-9a2c-13f8e21b7bfa",
            "name": "customer-acme-prod",
            "created_at": "2026-05-17T10:42:13.901Z",
            "is_active": true,
            "is_management": false,
            "spend_limit": 5.00,
            "spend_limit_period": "month",
            "expires_at": "2027-01-01T00:00:00.000Z"
        }
    ]
}
```

--------------------------------

### Create API key response example (201 Created)

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

Response for a successful key creation. The key field is the plaintext API key and will not be retrievable again. The new key behaves like dashboard-created keys, including rate limits.

```json
{
    "id": "8a5cf3a2-7b1e-4d6e-9a2c-13f8e21b7bfa",
    "name": "customer-acme-prod",
    "key": "f3b6a1c2d3e4f5061718293a4b5c6d7e8f9001112233445566778899aabbccdd",
    "created_at": "2026-05-17T10:42:13.901Z",
    "is_active": true,
    "is_management": false,
    "spend_limit": 5.00,
    "spend_limit_period": "month",
    "expires_at": "2027-01-01T00:00:00.000Z"
}
```

--------------------------------

### Generate images with Form-Data (Python)

Source: http://docs.imagerouter.io/api-reference/image-generation/

Python requests example for the /v1/openai/images/edits endpoint using multipart form data. Opens image and mask files and sends them as 'image[]' and 'mask' fields.

```python
import requests

url = "https://api.imagerouter.io/v1/openai/images/edits"
headers = {
  "Authorization": "Bearer YOUR_API_KEY"
}

payload = {
  "prompt": "YOUR_PROMPT",
  "model": "openai/gpt-image-1",
  "quality": "auto",
  "size": "auto",
  "response_format": "url",
  "output_format": "webp"
}

with open("your_image1.webp", "rb") as img1, \
  open("your_image2.webp", "rb") as img2, \
  open("your_mask.webp", "rb") as mask:
  files = {
      "image[]": [img1, img2],
      "mask[]": mask
  }
  response = requests.post(url, files=files, data=payload, headers=headers)
  print(response.json())
```

--------------------------------

### List normal API keys with Management key (Curl)

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

GET /v1/api-keys with Authorization: Bearer YOUR_MANAGEMENT_API_KEY. Returns metadata and key ids only; secret key values are never returned.

```bash
curl "https://api.imagerouter.io/v1/api-keys" \
-H "Authorization: Bearer YOUR_MANAGEMENT_API_KEY"
```

--------------------------------

### Successful deletion response

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

Example 200 OK response body after a successful deletion, containing the deleted key's id and a deleted flag set to true.

```json
{
    "id": "8a5cf3a2-7b1e-4d6e-9a2c-13f8e21b7bfa",
    "deleted": true
}
```

--------------------------------

### Generate images with Form-Data (JavaScript)

Source: http://docs.imagerouter.io/api-reference/image-generation/

JavaScript example using FormData for the /v1/openai/images/edits endpoint. Shows appending fields, adding image files (up to 16) from URL or local file, and optional mask file.

```javascript
const formData = new FormData()
formData.append('prompt', 'YOUR_PROMPT')
formData.append('model', 'openai/gpt-image-1')
formData.append('quality', 'auto')
formData.append('size', 'auto')
formData.append('response_format', 'url')
formData.append('output_format', 'webp')

// Add your image files (up to 16)
const imageFile1 = await fetch('your_image1.webp').then(r => r.blob())
formData.append('image[]', imageFile1)

// or from local file
const imagePath = '/home/phoenics/projects/Image router/materials/logo.png'
const imageBuffer = fs.readFileSync(imagePath)
const imageBlob = new Blob([imageBuffer], { type: 'image/png' })
formData.append('image[]', imageBlob, path.basename(imagePath))

// Add mask file - some models support/require it
//const maskFile = await fetch('your_mask.webp').then(r => r.blob())
//formData.append('mask[]', maskFile)

const response = await fetch('https://api.imagerouter.io/v1/openai/images/edits', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: formData
})

const data = await response.json()
console.log(data)
```

--------------------------------

### GET /v3/models

Source: http://docs.imagerouter.io/api-reference/models/

Retrieves a list of available models. The response includes model details such as id, architecture, pricing, supported parameters, and more. The fields returned can be controlled using the 'fields' query parameter.

```APIDOC
## [GET] /v3/models

### Description
Retrieves a list of available models. The response includes model details such as id, architecture, pricing, supported parameters, and more. The fields returned can be controlled using the 'fields' query parameter.

### Method
GET

### Endpoint
/v3/models

### Parameters
#### Query Parameters
- **fields** (string) - Optional - Comma-separated list of fields to include in each model object. If omitted, all fields are returned. The `id` field is always included.

### Response
#### Success Response (200)
- **id** (string) - The model identifier, e.g. `"openai/gpt-image-2"`
- **architecture** (object) - Input and output modalities (see below)
- **created** (number) - Release date as a Unix timestamp in seconds (may be absent)
- **pricing** (object) - Pricing info (see below)
- **supported_parameters** (string[]) - Names of the generation parameters the model accepts, e.g. `["quality", "size"]`
- **parameters** (object) - Allowed values for value-based parameters such as `size` and `seconds` (only present when applicable)
- **context_length** (number) - Maximum context window in tokens (text models only)
- **aliases** (string[]) - Alternative names for this model (only present if aliases exist)

**`architecture` object fields:**
- **input_modalities** (string[]) - Accepted input modalities, e.g. `["image"]`, `["text"]`, or `[]`
- **output_modalities** (string[]) - Produced output modalities, e.g. `["image"]`, `["video"]`, or `["text"]`

**`supported_parameters` values:**
- `quality` - Model supports quality settings
- `size` - Model supports output size selection (allowed values in `parameters.size`)
- `seconds` - Model supports output duration selection (allowed values in `parameters.seconds`)
- `mask` - Model supports a mask for inpainting

Text (LLM) models additionally report OpenAI-style parameters such as `temperature`, `max_tokens`, `top_p`, `tools`, and `tool_choice`.

**`parameters` object fields:**
- **size** (string[]) - Supported sizes, e.g. `["1024x1024", "auto"]` or `["custom"]`
- **seconds** ((number|string)[]) - Supported durations for video models, e.g. `[4, 6, 8]` or `["auto"]`

**`pricing` object:**
For image and video models, `pricing` contains aggregate per-generation pricing in USD:
- **min** (number) - Lowest price across configured providers (USD)
- **average** (number) - Representative/average price (USD)
- **max** (number) - Highest price across configured providers (USD)

For text (LLM) models, `pricing` is the upstream per-token pricing object (values are USD per token / per request), for example:
```
{
  "prompt": "0.15e-6",
  "completion": "0.6e-6",
  "image": "0",
  "request": "0",
  "input_cache_read": "0.075e-6",
  "input_cache_write": "0",
  "web_search": "0",
  "internal_reasoning": "0"
}
```

#### Response Example
Image model:
```
{
  "id": "openai/gpt-image-2",
  "architecture": {
    "input_modalities": ["image"],
    "output_modalities": ["image"]
  },
  "created": 1776729600,
  "pricing": { "min": 0.0062, "average": 0.0414, "max": 0.2 },
  "supported_parameters": ["quality", "size"],
  "parameters": {
    "size": ["auto", "1024x1024", "1536x1024", "1024x1536", "2560x1440", "3840x2160"]
  }
}
```

Video model:
```
{
  "id": "google/veo-2",
  "architecture": {
    "input_modalities": ["image"],
    "output_modalities": ["video"]
  },
  "created": 1734307200,
  "pricing": { "min": 1.875, "average": 1.875, "max": 1.875 },
  "supported_parameters": ["size", "seconds"],
  "parameters": {
    "size": ["1280x720", "720x1280", "1920x1080", "1080x1920"],
    "seconds": [5]
  }
}
```

Text (LLM) model:
```
{
  "id": "openai/gpt-4o-mini",
  "architecture": {
    "input_modalities": ["text"],
    "output_modalities": ["text"]
  },
  "created": 1721260800,
  "pricing": {
    "prompt": "0.15e-6",
    "completion": "0.6e-6",
    "image": "0",
    "request": "0",
    "input_cache_read": "0.075e-6",
    "input_cache_write": "0",
    "web_search": "0",
    "internal_reasoning": "0"
  },
  "supported_parameters": [
    "temperature", "max_tokens", "top_p",
    "frequency_penalty", "presence_penalty",
    "response_format", "tools", "tool_choice"
  ],
  "context_length": 128000
}
```

### Sorting Order
- `name`: Alphabetical (A-Z).
- `provider`: Alphabetical (A-Z).
- `price`: Ascending (lowest price first).
- `date`: Descending (newest first).
```

--------------------------------

### Error Response for Credit Endpoint

Source: http://docs.imagerouter.io/api-reference/credits/

Example error response when the request fails, with an internal_error type.

```json
{
    "error": {
        "message": "Failed to fetch credit information",
        "type": "internal_error"
    }
}
```

--------------------------------

### GET /v3/models/:modelId

Source: http://docs.imagerouter.io/api-reference/models/

Retrieves a single model by its id. Returns a single model object.

```APIDOC
## [GET] /v3/models/:modelId

### Description
Retrieves a single model by its id. Returns a single model object.

### Method
GET

### Endpoint
/v3/models/:modelId

### Parameters
#### Path Parameters
- **modelId** (string) - Required - The ID of the model.

### Response
#### Success Response (200)
- **id** (string) - The ID of the model.
- **architecture** (object) - Contains input and output modalities.
- **created** (number) - Creation timestamp.
- **pricing** (object) - Pricing information with min, average, and max values.
- **supported_parameters** (array) - List of supported parameters.
- **parameters** (object) - Parameter options.

#### Response Example
```
{
  "id": "openai/gpt-image-2",
  "architecture": {
    "input_modalities": ["image"],
    "output_modalities": ["image"]
  },
  "created": 1776729600,
  "pricing": {
    "min": 0.0062,
    "average": 0.0414, // usual cost for a 1024x1024 medium quality image
    "max": 0.2,
  },
  "supported_parameters": ["quality", "size"],
  "parameters": {
    "size": ["auto", "1024x1024", "1536x1024", "1024x1536", "2560x1440", "3840x2160"]
  }
}
```
```

--------------------------------

### Get remaining credits - Curl

Source: http://docs.imagerouter.io/api-reference/credits/

Curl command to retrieve account credit information. Requires an API key in the Authorization header.

```bash
curl "https://api.imagerouter.io/v1/credits" \
-H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### Create API key with spend limit and expiration (JavaScript)

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

Uses fetch to POST to /v1/api-keys with spend_limit, spend_limit_period, and expires_at. Comments note that spend_limit is USD (null or omit for no limit), spend_limit_period can be "day" | "week" | "month" | null (lifetime), and expires_at can be null or omitted for never.

```javascript
const response = await fetch('https://api.imagerouter.io/v1/api-keys', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_MANAGEMENT_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'customer-acme-prod',
    spend_limit: 5.00,           // USD; null or omit for no limit
    spend_limit_period: 'month', // "day" | "week" | "month" | null (lifetime)
    expires_at: '2027-01-01T00:00:00Z' // null or omit for never
  })
})
const data = await response.json()
console.log(data.key, data.spend_limit, data.spend_limit_period, data.expires_at)
```

--------------------------------

### Basic Chat Completion with Python (OpenAI SDK)

Source: http://docs.imagerouter.io/api-reference/chat-completions/

Uses the OpenAI Python SDK with ImageRouter's base URL to create a chat completion. Requires the 'openai' package and an API key.

```python
from openai import OpenAI

client = OpenAI(
  api_key="YOUR_API_KEY",
  base_url="https://api.imagerouter.io/v1/openai",
)

completion = client.chat.completions.create(
  model="openai/gpt-4o-mini",
  messages=[{"role": "user", "content": "Write a haiku about the ocean."}],
)

print(completion.choices[0].message.content)
```

--------------------------------

### GET /v3/models

Source: http://docs.imagerouter.io/api-reference/models/

Returns an array of model objects. Each object includes an id field identifying the model. Supports filtering, sorting, limits, and field selection.

```APIDOC
## [GET] /v3/models

### Description
Returns an array of model objects. Each object includes an `id` field identifying the model. This endpoint supports filtering, sorting, limits, and field selection to help you find exactly the models and metadata you need.

### Method
GET

### Endpoint
/v3/models

### Parameters
#### Query Parameters
- **output_modalities** (string) - Optional - Filter by output modality: `image`, `video`, or `text`
- **input_modalities** (string) - Optional - Filter by supported input modality: `image`, `mask`, `text`, `audio`, or `video`
- **provider** (string) - Optional - Filter by provider name (partial, case-insensitive), e.g. `google`, `openai`
- **free** (string) - Optional - `true` to show only free models, `false` to show only paid models
- **name** (string) - Optional - Filter by model name or alias (partial, case-insensitive)
- **sort** (string) - Optional - Sort by: `name`, `provider`, `price`, or `date`
- **limit** (number) - Optional - Maximum number of models to return
- **fields** (string) - Optional - Comma-separated list of fields to include in the response (see below)

### Response
#### Success Response (200)
Returns an array of model objects. Each object includes an `id` field. Additional fields depend on the `fields` parameter.

#### Response Example
```
[
  {
    "id": "openai/gpt-image-2",
    "aliases": ["gpt-image-2"],
    "architecture": {
      "input_modalities": ["image"],
      "output_modalities": ["image"]
    },
    "created": 1776729600,
    "pricing": {
      "min": 0.0062,
      "average": 0.0414,
      "max": 0.2
    },
    "supported_parameters": ["quality", "size"],
    "parameters": {
      "size": ["auto", "1024x1024", "1536x1024", "1024x1536", "2560x1440", "3840x2160"]
    }
  }
]
```
```

--------------------------------

### GET /v1/api-keys

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

Lists the normal API keys owned by the account behind the management key. Secret key values are never returned, only metadata and the key id.

```APIDOC
## GET /v1/api-keys

### Description
Lists the normal API keys owned by the account behind the management key. Secret key values are never returned, only metadata and the key id.

### Method
GET

### Endpoint
/v1/api-keys

### Parameters
#### Authorization
- **Authorization** (string) - Required - Bearer token with a management API key.

### Request Example
No request body required.

### Response
#### Success Response (200 OK)
- **data** (array) - Array of key metadata objects.
  - **id** (string) - Unique identifier for the API key.
  - **name** (string) - Name of the API key.
  - **created_at** (string) - Creation timestamp.
  - **is_active** (boolean) - Whether the key is active.
  - **is_management** (boolean) - Whether the key is a management key.
  - **spend_limit** (number) - Spend limit in USD.
  - **spend_limit_period** (string) - Period for the spend limit.
  - **expires_at** (string) - Expiration timestamp.

#### Response Example
{
  "data": [
    {
      "id": "8a5cf3a2-7b1e-4d6e-9a2c-13f8e21b7bfa",
      "name": "customer-acme-prod",
      "created_at": "2026-05-17T10:42:13.901Z",
      "is_active": true,
      "is_management": false,
      "spend_limit": 5.00,
      "spend_limit_period": "month",
      "expires_at": "2027-01-01T00:00:00.000Z"
    }
  ]
}
```

--------------------------------

### Create API key with spend limit and expiration (Python)

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

Uses requests.post to /v1/api-keys with spend_limit, spend_limit_period, and expires_at. Comments note that spend_limit is USD (None or omit for no limit), spend_limit_period can be "day" | "week" | "month" | None (lifetime), and expires_at can be None or omitted for never.

```python
import requests

url = "https://api.imagerouter.io/v1/api-keys"
headers = {
  "Authorization": "Bearer YOUR_MANAGEMENT_API_KEY",
  "Content-Type": "application/json"
}
payload = {
  "name": "customer-acme-prod",
  "spend_limit": 5.00,            # USD; None or omit for no limit
  "spend_limit_period": "month",  # "day" | "week" | "month" | None (lifetime)
  "expires_at": "2027-01-01T00:00:00Z",  # None or omit for never
}

response = requests.post(url, headers=headers, json=payload)
data = response.json()
print(data["key"], data["spend_limit"], data["spend_limit_period"], data["expires_at"])
```

--------------------------------

### Create API key with spend limit and expiration (Curl)

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

POST to /v1/api-keys with spend_limit, spend_limit_period, and expires_at. Requires Authorization: Bearer YOUR_MANAGEMENT_API_KEY. When the key reaches the monthly cap, generation requests return an error until the next 1st of the month at 00:00 UTC, or until the limit is raised/removed.

```bash
curl -X POST "https://api.imagerouter.io/v1/api-keys" \
-H "Authorization: Bearer YOUR_MANAGEMENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
      "name": "customer-acme-prod",
      "spend_limit": 5.00,
      "spend_limit_period": "month",
      "expires_at": "2027-01-01T00:00:00Z"
    }'
```

--------------------------------

### GET /v1/credits

Source: http://docs.imagerouter.io/api-reference/credits/

Retrieves the account's credit information, including remaining credits, total usage, and total deposits. Requires authentication via Bearer token.

```APIDOC
## GET /v1/credits

### Description
Retrieves your account's credit information, including remaining credits, total usage, and total deposits.

### Method
GET

### Endpoint
https://api.imagerouter.io/v1/credits

### Parameters
#### Query Parameters
- **by_api_key** (boolean) - Optional - When set to `true`, returns a detailed usage breakdown for each API key.

### Request Example
```
curl "https://api.imagerouter.io/v1/credits" \
-H "Authorization: Bearer YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **remaining_credits** (string) - Remaining credits in the account.
- **credit_usage** (string) - Total credits used.
- **total_deposits** (string) - Total credits deposited.
- **usage_by_api_key** (array) - Optional. Detailed usage per API key when `by_api_key=true` is passed.

#### Response Example
```
{
    "remaining_credits": "25.5000",
    "credit_usage": "4.5000",
    "total_deposits": "30.0000"
}
```

#### Detailed Usage by API Key Response Example
```
{
    "remaining_credits": "25.5000",
    "credit_usage": "4.5000",
    "total_deposits": "30.0000",
    "usage_by_api_key": [
        {
            "api_key_id": "d9eb93dc-56b1-4216-91b5-a44944508bbc",
            "api_key_name": "Production Key",
            "credit_usage": "4.2000",
            "total_requests": 150,
            "created_at": "2023-10-01T12:00:00.000Z",
            "is_active": true,
            "spend_limit": "5.0000",
            "spend_limit_period": "month",
            "period_spend": "1.2000",
            "period_start": "2026-05-01T00:00:00.000Z",
            "expires_at": "2027-01-01T00:00:00.000Z"
        },
        {
            "api_key_id": "temp_jwt",
            "api_key_name": "Temporary web token (imagerouter.io)",
            "credit_usage": "0.0300",
            "total_requests": 45,
            "created_at": null,
            "is_active": false,
            "spend_limit": null,
            "spend_limit_period": null,
            "period_spend": "0.0300",
            "period_start": null,
            "expires_at": null
        }
    ]
}
```

#### Per-key Fields
- **spend_limit** (string/null) - USD cap for the key's current window, or `null` when no cap is set.
- **spend_limit_period** (string/null) - `"day"` / `"week"` / `"month"` reset window, or `null` for a lifetime cap.
- **period_spend** (string) - USD spent in the current window. Equals `credit_usage` when `spend_limit_period` is `null`.
- **period_start** (string/null) - UTC timestamp marking the start of the current window. `null` when no period is set or the key has not been used in the current window scheme.
- **expires_at** (string/null) - UTC timestamp at which the key is automatically rejected, or `null` when the key never expires.

#### Error Response
```
{
    "error": {
        "message": "Failed to fetch credit information",
        "type": "internal_error"
    }
}
```

#### Notes
- The endpoint only counts deposits with status `COMPLETED`.
- Credit usage is calculated as: `total_deposits - remaining_credits`.
```

--------------------------------

### Basic Chat Completion with JavaScript (OpenAI SDK)

Source: http://docs.imagerouter.io/api-reference/chat-completions/

Uses the OpenAI JavaScript SDK with ImageRouter's base URL to create a chat completion. Requires the 'openai' package and an API key.

```javascript
import OpenAI from 'openai'

const client = new OpenAI({
apiKey: 'YOUR_API_KEY',
baseURL: 'https://api.imagerouter.io/v1/openai',
})

const completion = await client.chat.completions.create({
model: 'openai/gpt-4o-mini',
messages: [{ role: 'user', content: 'Write a haiku about the ocean.' }],
})

console.log(completion.choices[0].message.content)
```

--------------------------------

### Basic text generation with Responses API (Python)

Source: http://docs.imagerouter.io/api-reference/responses/

Use this Python code with the OpenAI SDK to generate text. Configure the client with your API key and the ImageRouter base URL, then call client.responses.create and print the output_text.

```python
from openai import OpenAI

client = OpenAI(
  api_key="YOUR_API_KEY",
  base_url="https://api.imagerouter.io/v1/openai",
)

response = client.responses.create(
  model="openai/gpt-4o-mini",
  input="Write a haiku about the ocean.",
)

print(response.output_text)
```

--------------------------------

### Basic text generation with Responses API (Curl)

Source: http://docs.imagerouter.io/api-reference/responses/

Use this Curl command to generate text with the Responses API. Replace YOUR_API_KEY with your actual key. The model is set to openai/gpt-4o-mini and the input is a prompt for a haiku.

```bash
curl 'https://api.imagerouter.io/v1/openai/responses' \
-H 'Authorization: Bearer YOUR_API_KEY' \
--json '{
  "model": "openai/gpt-4o-mini",
  "input": "Write a haiku about the ocean."
}'
```

--------------------------------

### 404 Not Found error response

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

Example error response when the id does not exist, is not owned by the management key's account, or refers to a management key. The error message is 'API key not found'.

```json
{
    "error": {
        "message": "API key not found",
        "type": "invalid_request_error",
        "param": "id"
    }
}
```

--------------------------------

### Generate Video with Form-Data (JavaScript)

Source: http://docs.imagerouter.io/api-reference/video-generation/

Builds a FormData object and appends fields, including image files (up to 16) via 'image[]'. Shows how to add a local file using fs and Blob.

```javascript
const formData = new FormData()
formData.append('prompt', 'YOUR_PROMPT')
formData.append('model', 'ir/test-video')
formData.append('size', 'auto')
formData.append('seconds', 'auto')
formData.append('response_format', 'url')

// Add your image files (up to 16)
const imageFile1 = await fetch('your_image1.webp').then(r => r.blob())
formData.append('image[]', imageFile1)

// or from local file
const imagePath = '/home/phoenics/projects/Image router/materials/logo.png'
const imageBuffer = fs.readFileSync(imagePath)
const imageBlob = new Blob([imageBuffer], { type: 'image/png' })
formData.append('image[]', imageBlob, path.basename(imagePath))

const response = await fetch('https://api.imagerouter.io/v1/openai/videos/generations', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: formData
})

const data = await response.json()
console.log(data)
```

--------------------------------

### Create normal API key with management key - JavaScript

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

Uses fetch to POST to /v1/api-keys with a Bearer management key. The response contains the new normal API key in plain text; store it securely.

```javascript
const response = await fetch('https://api.imagerouter.io/v1/api-keys', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_MANAGEMENT_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ name: 'production worker #1' })
})
const data = await response.json()
console.log(data.key) // the new normal API key - store it now
```

--------------------------------

### List normal API keys with Management key (Python)

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

Uses requests.get to /v1/api-keys with Authorization header. Prints the data array of key metadata (no secrets).

```python
import requests

url = "https://api.imagerouter.io/v1/api-keys"
headers = {"Authorization": "Bearer YOUR_MANAGEMENT_API_KEY"}

response = requests.get(url, headers=headers)
print(response.json()["data"])  # array of key metadata (no secrets)
```

--------------------------------

### Unauthorized error when using a normal key

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

Example error response when a normal API key is used instead of a management key. The error message instructs to generate a management key in the dashboard.

```json
{
    "error": {
        "message": "This endpoint requires a management API key. Generate one in your API keys dashboard.",
        "type": "unauthorized"
    }
}
```

--------------------------------

### Create normal API key with management key - Python

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

Uses requests.post to POST to /v1/api-keys with a Bearer management key. The response contains the new normal API key in plain text; store it securely.

```python
import requests

url = "https://api.imagerouter.io/v1/api-keys"
headers = {
  "Authorization": "Bearer YOUR_MANAGEMENT_API_KEY",
  "Content-Type": "application/json"
}
payload = {"name": "production worker #1"}

response = requests.post(url, headers=headers, json=payload)
print(response.json()["key"])  # the new normal API key - store it now
```

--------------------------------

### POST /v1/api-keys

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

Creates a new API key. Supports optional monthly spend limits and expiration dates. Returns the new key's metadata including the plaintext key value.

```APIDOC
## POST /v1/api-keys

### Description
Creates a new API key. Supports optional monthly spend limits and expiration dates. Returns the new key's metadata including the plaintext key value.

### Method
POST

### Endpoint
/v1/api-keys

### Parameters
#### Request Body
- **name** (string) - Required - Name of the API key.
- **spend_limit** (number) - Optional - Spend limit in USD. Omit or null for no limit.
- **spend_limit_period** (string) - Optional - Period for the spend limit: "day", "week", "month", or null for lifetime.
- **expires_at** (string) - Optional - ISO 8601 timestamp for expiration. Omit or null for never.

### Request Example
{
  "name": "customer-acme-prod",
  "spend_limit": 5.00,
  "spend_limit_period": "month",
  "expires_at": "2027-01-01T00:00:00Z"
}

### Response
#### Success Response (201 Created)
- **id** (string) - Unique identifier for the API key.
- **name** (string) - Name of the API key.
- **key** (string) - Plaintext API key. Not retrievable again.
- **created_at** (string) - Creation timestamp.
- **is_active** (boolean) - Whether the key is active.
- **is_management** (boolean) - Whether the key is a management key.
- **spend_limit** (number) - Spend limit in USD.
- **spend_limit_period** (string) - Period for the spend limit.
- **expires_at** (string) - Expiration timestamp.

#### Response Example
{
  "id": "8a5cf3a2-7b1e-4d6e-9a2c-13f8e21b7bfa",
  "name": "customer-acme-prod",
  "key": "f3b6a1c2d3e4f5061718293a4b5c6d7e8f9001112233445566778899aabbccdd",
  "created_at": "2026-05-17T10:42:13.901Z",
  "is_active": true,
  "is_management": false,
  "spend_limit": 5.00,
  "spend_limit_period": "month",
  "expires_at": "2027-01-01T00:00:00.000Z"
}
```

--------------------------------

### POST /v1/api-keys

Source: http://docs.imagerouter.io/api-reference/management-api-keys/

Mints a fresh normal API key for the account that owns the supplied management key. The new key is returned in plain text only on this response - store it securely.

```APIDOC
## POST /v1/api-keys

### Description
Mints a fresh **normal** API key for the account that owns the supplied management key. The new key is returned in plain text only on this response - store it securely.

### Method
POST

### Endpoint
/v1/api-keys

### Authorization
- **Authorization** (string) - Required - Must be `Bearer <MANAGEMENT_API_KEY>`. Normal keys, temporary tokens and disabled / non-management / expired keys are rejected with `401 Unauthorized`.

### Parameters
#### Request Body
- **name** (string) - Required - Human-readable name for the new key (max 200 chars).
- **spend_limit** (number) - Optional - Optional spend cap in USD. Requests are blocked once the key has spent this amount within the current window (see `spend_limit_period`). May be edited later in the dashboard.
- **spend_limit_period** (string) - Optional - Optional reset window for `spend_limit`. `day`, `week` and `month` reset at **00:00 UTC** on the corresponding boundary (today, Monday of this ISO week, or the 1st of this calendar month). Omit or `null` for a lifetime/cumulative cap. Requires `spend_limit` to also be set.
- **expires_at** (string) - Optional - Optional expiration timestamp. The key automatically stops working at that time. Must be in the future. Omit or `null` for a key that never expires.

### Request Example
{
  "name": "production worker #1"
}

### Response
#### Success Response (200)
- **key** (string) - The new normal API key - store it now.

#### Response Example
{
  "key": "new_normal_api_key"
}

### Error Handling
- **401 Unauthorized** - Returned if the Authorization header is missing, invalid, or the key is not a valid management key.
```
Tokens:
Raw