> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Apiframe

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

![Apiframe logo](https://mintcdn.com/composio-preview/6S5R4NszqpnVIZRD/images/toolkits/apiframe.svg?fit=max\&auto=format\&n=6S5R4NszqpnVIZRD\&q=85\&s=9115f4b98d787cdecf9a5a36922567d4)

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

## Tools

> [accordion] 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
>
> **generation** `string` *required*
>
> Complete official model-discriminated image request. Include the model, prompt, optional webhook fields, and only that model's parameter block.
>
> **idempotency\_key** `string`
>
> Stable retry key. Reusing it within 24 hours returns the original job instead of charging for a duplicate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **generation** `string` *required*
>
> 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`
>
> Stable retry key. Reusing it within 24 hours returns the original job instead of creating and charging for a duplicate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **generation** `string` *required*
>
> Complete official model-discriminated Apiframe video generation request.
>
> **idempotency\_key** `string`
>
> Stable retry key. Reusing it within 24 hours returns the original job instead of creating and charging for a duplicate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account
>
> **Slug:** `APIFRAME_GET_ACCOUNT`
>
> Return the authenticated Apiframe user, team plan and credit balance, role, and active API-key metadata.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **job\_id** `string` *required*
>
> Job UUID returned by a generation tool or List Jobs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Jobs
>
> **Slug:** `APIFRAME_LIST_JOBS`
>
> Return one page of generation jobs, optionally filtered by status, model, job ID, or ownership scope.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum jobs to return in this page (1-100).
>
> **model** `string`
>
> Filter by an exact model ID from List Models.
>
> **scope** `string ("user" | "team")`
>
> Use user for the caller's jobs. Team requires an ADMIN team role and otherwise returns 403.
>
> **search** `string`
>
> Find a specific job by UUID within the selected scope.
>
> **status** `string ("QUEUED" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED")`
>
> Filter jobs by lifecycle status.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged.
>
> **include\_models** `boolean`
>
> Also return model IDs represented by the result set.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Models
>
> **Slug:** `APIFRAME_LIST_MODELS`
>
> List Apiframe image, video, or music models, with pricing and model-specific control metadata when available.
>
> #### Input Parameters
>
> **modality** `string ("image" | "video" | "music")`
>
> Return only models for this modality; omit to return the full curated catalog.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
