---
canonical_url: "https://docs.composio.dev/toolkits/apiframe"
markdown_url: "https://docs.composio.dev/toolkits/apiframe.md"
product: "platform"
version: null
last_updated: null
---

# Apiframe

Apiframe provides one API for generating and managing AI images, videos, music, uploads, assets, jobs, and custom LoRAs.

- **Category:** ai content generation
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 7
- **Triggers:** 0
- **Slug:** `APIFRAME`
- **Version:** 00000000_00

## Tools

### Generate Image

**Slug:** `APIFRAME_GENERATE_IMAGE`

Submit a paid image generation job that consumes Apiframe credits based on the selected model and controls. Call List Models for pricing and controls, then Get Job with the returned job_id to retrieve the result.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `generation` | string | Yes | Complete official model-discriminated image request. Include the model, prompt, optional webhook fields, and only that model's parameter block. |
| `idempotency_key` | string | No | Stable retry key. Reusing it within 24 hours returns the original job instead of charging for a duplicate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Music

**Slug:** `APIFRAME_GENERATE_MUSIC`

Submit a paid music generation job that consumes Apiframe credits, with cost and output count varying by model. Call List Models for pricing and controls, then Get Job with the returned job_id to retrieve the generated tracks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `generation` | string | Yes | Complete request for exactly one supported music model. Suno, Udio, and Producer return two tracks; Lyria and ElevenLabs return one; Mureka returns murekaParams.n tracks (1-3, default 2). |
| `idempotency_key` | string | No | Stable retry key. Reusing it within 24 hours returns the original job instead of creating and charging for a duplicate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Video

**Slug:** `APIFRAME_GENERATE_VIDEO`

Submit a paid video generation job that consumes Apiframe credits based on the selected model and controls. Call List Models for pricing and controls, then Get Job with the returned job_id to retrieve the result.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `generation` | string | Yes | Complete official model-discriminated Apiframe video generation request. |
| `idempotency_key` | string | No | Stable retry key. Reusing it within 24 hours returns the original job instead of creating and charging for a duplicate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account

**Slug:** `APIFRAME_GET_ACCOUNT`

Return the authenticated Apiframe user, team plan and credit balance, role, and active API-key metadata.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job

**Slug:** `APIFRAME_GET_JOB`

Get the current status, progress, provider-specific result, cost, and error details for one Apiframe generation job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Job UUID returned by a generation tool or List Jobs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Jobs

**Slug:** `APIFRAME_LIST_JOBS`

Return one page of generation jobs, optionally filtered by status, model, job ID, or ownership scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum jobs to return in this page (1-100). |
| `model` | string | No | Filter by an exact model ID from List Models. |
| `scope` | string ("user" | "team") | No | Use user for the caller's jobs. Team requires an ADMIN team role and otherwise returns 403. |
| `search` | string | No | Find a specific job by UUID within the selected scope. |
| `status` | string ("QUEUED" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED") | No | Filter jobs by lifecycle status. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged. |
| `include_models` | boolean | No | Also return model IDs represented by the result set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Models

**Slug:** `APIFRAME_LIST_MODELS`

List Apiframe's current image, video, or music models with pricing and the complete live model-specific control metadata needed to construct generation requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `modality` | string ("image" | "video" | "music") | No | Return only models for this modality; omit to return the full curated catalog. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |