Stability AI Developer Platform

https://platform.stability.ai/docs
Admin
The Stability AI Developer Platform provides access to AI models for generating images and other...
Tokens:47,912
Snippets:450
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Stability SDK

Source: https://platform.stability.ai/docs/features/text-to-image?tab=typescript

Install the Stability SDK package using pip. This is the first step to using the SDK.

```bash
pip install stability-sdk
```

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

### Perform Audio-to-Audio Generation

Source: https://platform.stability.ai/docs/api-reference

Example demonstrating how to submit an audio-to-audio generation request and poll the results endpoint until the audio is ready.

```python
import requests, time

response = requests.post(
    f"https://api.stability.ai/v2beta/audio/stable-audio/audio-to-audio",
    headers={"authorization": f"Bearer sk-MYAPIKEY", "accept": "audio/*"},
    files={"audio": open("./input.mp3", "rb")},
    data={
        "prompt": "Add a lush reverb and layer in warm ambient pads.",
        "output_format": "mp3",
        "duration": 30,
        "strength": 0.5,
    },
)

if response.status_code != 202:
    raise Exception(str(response.json()))

generation_id = response.json()["id"]

while True:
    result = requests.get(
        f"https://api.stability.ai/v2beta/audio/results/{generation_id}",
        headers={"authorization": f"Bearer sk-MYAPIKEY", "accept": "audio/*"},
    )
    if result.status_code == 202:
        print("Generation in-progress, retrying in 10 seconds...")
        time.sleep(10)
    elif result.status_code == 200:
        with open("./output.mp3", "wb") as f:
            f.write(result.content)
        break
    else:
        raise Exception(str(result.json()))
```

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

### Image-to-Image Transformation Setup

Source: https://platform.stability.ai/docs/features/image-to-image?tab=typescript

Prepare to modify an existing image using a new prompt. This involves setting up an initial image based on a previous generation or a provided source.

```python

```

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

### Outpaint Image Request

Source: https://platform.stability.ai/docs/api-reference

Example demonstrating how to send an image for outpainting using the requests library in Python.

```python
import requests

response = requests.post(
    f"https://api.stability.ai/v2beta/stable-image/edit/outpaint",
    headers={
        "authorization": f"Bearer sk-MYAPIKEY",
        "accept": "image/*"
    },
    files={
        "image": open("./husky-in-a-field.png", "rb")
    },
    data={
        "left": 200,
        "down": 200,
        "output_format": "webp"
    },
)

if response.status_code == 200:
    with open("./husky-in-a-huge-field.webp", 'wb') as file:
        file.write(response.content)
else:
    raise Exception(str(response.json()))
```

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

### Setup Environment Variables and API Key

Source: https://platform.stability.ai/docs/features/text-to-image?tab=typescript

Import necessary dependencies and configure environment variables for the Stability AI API, including the host URL and API key. Ensure your API key is kept secure.

```python
import os
import io
import warnings
from PIL import Image
from stability_sdk import client
import stability_sdk.interfaces.gooseai.generation.generation_pb2 as generation

os.environ['STABILITY_HOST'] = 'grpc.stability.ai:443'
os.environ['STABILITY_KEY'] = 'key-goes-here'
```

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

### Multi-prompt text-to-image parameters

Source: https://platform.stability.ai/docs/features/multi-prompting

Configure parameters for multi-prompt text-to-image generation, allowing for weighted prompts and negative prompting to guide the image generation process.

```python
# Note: With multi-prompting, we can provide each prompt a specific weight. Negative weights are used to prompt the model to avoid certain concepts.
```

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

### Perform Audio Inpainting Request

Source: https://platform.stability.ai/docs/api-reference

Example of using the requests library in Python to send an audio file and prompt to the inpainting endpoint.

```python
import requests

response = requests.post(
    f"https://api.stability.ai/v2beta/audio/stable-audio-2/inpaint",
    headers={"authorization": f"Bearer sk-MYAPIKEY", "accept": "audio/*"},
    files={
        "audio": open("./uk-bass-base.mp3", "rb"),
    },
    data={
        "prompt": "A song in the 3/4 time signature that features cheerful acoustic guitar, live recorded drums, and rhythmic claps, The mood is happy and up-lifting.",
        "output_format": "mp3",
        "duration": 20,
    },
)

if response.status_code == 200:
    with open("./output.mp3", "wb") as file:
        file.write(response.content)
else:
    raise Exception(str(response.json()))
```

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

### Perform Creative Upscale Request

Source: https://platform.stability.ai/docs/api-reference

Example of how to send an image for creative upscaling using the requests library in Python.

```python
import requests

response = requests.post(
    f"https://api.stability.ai/v2beta/stable-image/upscale/creative",
    headers={
        "authorization": f"Bearer sk-MYAPIKEY",
        "accept": "image/*"
    },
    files={
        "image": open("./kitten-in-space.png", "rb")
    },
    data={
        "prompt": "cute fluffy white kitten floating in space, pastel colors",
        "output_format": "webp",
    },
)

print("Generation ID:", response.json().get('id'))
```

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

### Generate 3D Model Request

Source: https://platform.stability.ai/docs/api-reference

Python example for sending a POST request to the 3D point-aware generation endpoint and saving the resulting GLB file.

```python
import requests

response = requests.post(
    f"https://api.stability.ai/v2beta/3d/stable-point-aware-3d",
    headers={
        "authorization": f"Bearer sk-MYAPIKEY",
    },
    files={
        "image": open("./cat-statue.png", "rb")
    },
    data={},
)

if response.status_code == 200:
    with open("./3d-cat-statue.glb", 'wb') as file:
        file.write(response.content)
else:
    raise Exception(str(response.json()))
```

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

### Import Dependencies and Set Up Environment

Source: https://platform.stability.ai/docs/features/inpainting?tab=typescript

Import necessary libraries and configure environment variables for API key and host. Ensure your API key is kept secure.

```python
import os
import io
import warnings

from PIL import Image
from stability_sdk import client
import stability_sdk.interfaces.gooseai.generation.generation_pb2 as generation
from torchvision.transforms import GaussianBlur

# Our host url should not be prepended with "https" nor should it have a trailing slash.
os.environ['STABILITY_HOST'] = 'grpc.stability.ai:443'

# Sign up for an account at the following link to get an API Key.
# https://platform.stability.ai/

# Click on the following link once you have created an account to be taken to your API Key.
# https://platform.stability.ai/account/keys

# Paste your API Key below.

os.environ['STABILITY_KEY'] = 'apikeyhere'
```

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

### GET /v1/engines/list

Source: https://platform.stability.ai/docs/api-reference

Retrieves a list of all engines available to the organization or user.

```APIDOC
## GET /v1/engines/list

### Description
List all engines available to your organization or user.

### Method
GET

### Endpoint
https://api.stability.ai/v1/engines/list

### Parameters
#### Header Parameters
- **Organization** (string) - Optional - Allows for requests to be scoped to an organization other than the user's default.
- **Stability-Client-ID** (string) - Optional - Used to identify the source of requests.
- **Stability-Client-Version** (string) - Optional - Used to identify the version of the application.

### Response
#### Success Response (200)
- **engines** (array) - List of available engines.
```

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

### GET /v1/user/account

Source: https://platform.stability.ai/docs/api-reference

Retrieves information about the account associated with the provided API key.

```APIDOC
## GET /v1/user/account

### Description
Get information about the account associated with the provided API key.

### Method
GET

### Endpoint
https://api.stability.ai/v1/user/account

### Response
#### Success Response (200)
- **email** (string) - User email address
- **id** (string) - User ID
- **organizations** (array) - List of organizations the user belongs to
- **profile_picture** (string) - URL to the user's profile picture

#### Response Example
{
  "email": "example@stability.ai",
  "id": "user-1234",
  "organizations": [
    {
      "id": "org-5678",
      "name": "Another Organization",
      "role": "MEMBER",
      "is_default": true
    }
  ],
  "profile_picture": "https://api.stability.ai/example.png"
}
```

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

### GET /v1/user/balance

Source: https://platform.stability.ai/docs/api-reference

Retrieves the credit balance of the account or organization associated with the API key.

```APIDOC
## GET /v1/user/balance

### Description
Get the credit balance of the account/organization associated with the API key.

### Method
GET

### Endpoint
https://api.stability.ai/v1/user/balance

### Parameters
#### Header Parameters
- **Organization** (string) - Optional - Allows for requests to be scoped to an organization other than the user's default.
- **Stability-Client-ID** (string) - Optional - Used to identify the source of requests.
- **Stability-Client-Version** (string) - Optional - Used to identify the version of the application or service making the requests.
```

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

### Set Up Environment Variables and API Key

Source: https://platform.stability.ai/docs/features/image-to-image?tab=typescript

Import dependencies, configure API host, and set your Stability AI API key using environment variables. Ensure your API key is kept secure.

```python
import io
import os
import warnings

from PIL import Image
from stability_sdk import client
import stability_sdk.interfaces.gooseai.generation.generation_pb2 as generation

# Our Host URL should not be prepended with "https" nor should it have a trailing slash.
os.environ['STABILITY_HOST'] = 'grpc.stability.ai:443'

# Sign up for an account at the following link to get an API Key.
# https://platform.stability.ai/

# Click on the following link once you have created an account to be taken to your API Key.
# https://platform.stability.ai/account/keys

# Paste your API Key below.

os.environ['STABILITY_KEY'] = 'key-goes-here'
```

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

### GET /v2beta/audio/results/{id}

Source: https://platform.stability.ai/docs/api-reference

Polls the status of an audio generation task and retrieves the result.

```APIDOC
## GET /v2beta/audio/results/{id}

### Description
Retrieves the result of an audio generation task. If the task is still in progress, it returns a 202 status code. Once complete, it returns the audio content.

### Method
GET

### Endpoint
https://api.stability.ai/v2beta/audio/results/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The generation ID returned by the initial POST request.

### Response
#### Success Response (200)
- **content** (binary) - The generated audio file.
```

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

### Example JSON response structure

Source: https://platform.stability.ai/docs/api-reference

Represents the expected JSON format for API responses.

```json
{
  "credits": 0.6336833840314097
}
```

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

### Generate Image with Parameters

Source: https://platform.stability.ai/docs/features/text-to-image?tab=typescript

Set up initial generation parameters for text-to-image generation, including prompt, seed, steps, CFG scale, dimensions, and sampler. The code also includes logic to save the generated image and warn if safety filters are triggered.

```python
# Set up our initial generation parameters.
answers = stability_api.generate(
    prompt="expansive landscape rolling greens with gargantuan yggdrasil, intricate world-spanning roots towering under a blue alien sky, masterful, ghibli",
    seed=4253978046, # If a seed is provided, the resulting generated image will be deterministic.
                     # What this means is that as long as all generation parameters remain the same, you can always recall the same image simply by generating it again.
                     # Note: This isn't quite the case for Clip Guided generations, which we'll tackle in a future example notebook.
    steps=50, # Amount of inference steps performed on image generation. Defaults to 30. 
    cfg_scale=8.0, # Influences how strongly your generation is guided to match your prompt.
                   # Setting this value higher increases the strength in which it tries to match your prompt.
                   # Defaults to 7.0 if not specified.
    width=1024, # Generation width, defaults to 512 if not included.
    height=1024, # Generation height, defaults to 512 if not included.
    samples=1, # Number of images to generate, defaults to 1 if not included.
    sampler=generation.SAMPLER_K_DPMPP_2M # Choose which sampler we want to denoise our generation with.
                                                 # Defaults to k_dpmpp_2m if not specified. Clip Guidance only supports ancestral samplers.
                                                 # (Available Samplers: ddim, plms, k_euler, k_euler_ancestral, k_heun, k_dpm_2, k_dpm_2_ancestral, k_dpmpp_2s_ancestral, k_lms, k_dpmpp_2m, k_dpmpp_sde)
)

# Set up our warning to print to the console if the adult content classifier is tripped.
# If adult content classifier is not tripped, save generated images.
for resp in answers:
    for artifact in resp.artifacts:
        if artifact.finish_reason == generation.FILTER:
            warnings.warn(
                "Your request activated the API's safety filters and could not be processed."
                "Please modify the prompt and try again.")
        if artifact.type == generation.ARTIFACT_IMAGE:
            img = Image.open(io.BytesIO(artifact.binary))
            img.save(str(artifact.seed)+ ".png") # Save our generated images with their seed number as the filename.
```

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

### API Error Response Format

Source: https://platform.stability.ai/docs/api-reference

Example of the JSON structure returned when an API request fails.

```json
{
  "id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "name": "bad_request",
  "errors": [
    "some-field: is required"
]

}
```

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

### Set Initial Generation Parameters

Source: https://platform.stability.ai/docs/features/image-to-image?tab=typescript

Configure parameters for image generation, including prompt, initial image, seed, and generation settings. Ensure all necessary imports are present before execution.

```python
answers2 = stability_api.generate(
    prompt="crayon drawing of rocket ship launching from forest",
    init_image=img, # Assign our previously generated img as our Initial Image for transformation. 
    start_schedule=0.6, # Set the strength of our prompt in relation to our initial image.
    seed=123463446, # If attempting to transform an image that was previously generated with our API,
                    # initial images benefit from having their own distinct seed rather than using the seed of the original image generation.
    steps=50, # Amount of inference steps performed on image generation. Defaults to 30.
    cfg_scale=8.0, # Influences how strongly your generation is guided to match your prompt. 
                   # Setting this value higher increases the strength in which it tries to match your prompt. 
                   # Defaults to 7.0 if not specified.
    width=1024, # Generation width, defaults to 512 if not included.
    height=1024, # Generation height, defaults to 512 if not included.
    sampler=generation.SAMPLER_K_DPMPP_2M # Choose which sampler we want to denoise our generation with. 
                                                 # Defaults to k_dpmpp_2m if not specified. Clip Guidance only supports ancestral samplers. 
                                                 # (Available Samplers: ddim, plms, k_euler, k_euler_ancestral, k_heun, k_dpm_2, k_dpm_2_ancestral, k_dpmpp_2s_ancestral, k_lms, k_dpmpp_2m, k_dpmpp_sde)
)
```

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

### Result Content Representation

Source: https://platform.stability.ai/docs/api-reference

Example representation of the raw bytes returned for generated image formats.

```text
The bytes of the generated png
```

```text
The bytes of the generated jpeg
```

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

### Image-to-Image Masking Request Payload

Source: https://platform.stability.ai/docs/api-reference

Example JSON payload for the image-to-image masking endpoint using multipart/form-data.

```json
{
  "mask_source": "MASK_IMAGE_BLACK",
  "init_image": "<image binary>",
  "mask_image": "<image binary>",
  "text_prompts[0][text]": "A dog space commander",
  "text_prompts[0][weight]": 1,
  "cfg_scale": 7,
  "sampler": "K_DPM_2_ANCESTRAL",
  "samples": 3,
  "steps": 30
}
```

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

### POST /v2beta/audio/stable-audio/inpaint

Source: https://platform.stability.ai/docs/api-reference

Initiates an asynchronous audio inpainting generation task.

```APIDOC
## POST /v2beta/audio/stable-audio/inpaint

### Description
Transforms existing audio samples into new high-quality compositions using text instructions. This endpoint is asynchronous and returns a generation ID.

### Method
POST

### Endpoint
https://api.stability.ai/v2beta/audio/stable-audio/inpaint

### Parameters
#### Header Parameters
- **authorization** (string) - Required - Your Stability API key.
- **content-type** (string) - Required - Must be multipart/form-data.
- **accept** (string) - Optional - Specify audio/* or application/json.
- **stability-client-id** (string) - Optional - Name of your application.
- **stability-client-user-id** (string) - Optional - Unique identifier for your end user.
- **stability-client-version** (string) - Optional - Version of your application.

#### Request Body (multipart/form-data)
- **prompt** (string) - Required - Descriptive text defining the desired output audio.
- **audio** (binary) - Required - The starting audio file (mp3 or wav, 6-380 seconds).
- **model** (string) - Optional - The model to use (default: stable-audio-3).
- **duration** (number) - Optional - Duration in seconds (1-380).
- **seed** (number) - Optional - Randomness seed (0-4294967294).
- **steps** (integer) - Optional - Sampling steps (4-8).
- **cfg_scale** (number) - Optional - Prompt adherence scale (1-25).
- **output_format** (string) - Optional - mp3 or wav.
- **mask_start** (number) - Optional - Start time for masking (0-380).
- **mask_end** (number) - Optional - End time for masking (0-380).

### Response
#### Success Response (202)
- **id** (string) - The unique identifier for the generation task.

#### Response Example
{
  "id": "a6dc6c6e20acda010fe14d71f180658f2896ed9b4ec25aa99a6ff06c796987c4"
}
```

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

### Basic text-to-image generation parameters

Source: https://platform.stability.ai/docs/features/multi-prompting

Configure parameters for text-to-image generation, including prompt, seed, steps, CFG scale, dimensions, and sampler. The safety filter status is checked, and images are saved with their seed as the filename.

```python
answers = stability_api.generate(
    prompt="beautiful night sky above japanese town, anime style",
    seed=1229080980, # If a seed is provided, the resulting generated image will be deterministic.
                     # What this means is that as long as all generation parameters remain the same, you can always recall the same image simply by generating it again.
                     # Note: This isn't quite the case for CLIP Guided generations, which we tackle in the CLIP Guidance documentation.
    steps=50, # Amount of inference steps performed on image generation. Defaults to 30.
    cfg_scale=8.0, # Influences how strongly your generation is guided to match your prompt.
                   # Setting this value higher increases the strength in which it tries to match your prompt.
                   # Defaults to 7.0 if not specified.
    width=1024, # Generation width, if not included defaults to 512 or 1024 depending on the engine.
    height=1024, # Generation height, if not included defaults to 512 or 1024 depending on the engine.
    samples=1, # Number of images to generate, defaults to 1 if not included.
    sampler=generation.SAMPLER_K_DPMPP_2M # Choose which sampler we want to denoise our generation with.
                                                 # Defaults to k_dpmpp_2m if not specified. Clip Guidance only supports ancestral samplers.
                                                 # (Available Samplers: ddim, plms, k_euler, k_euler_ancestral, k_heun, k_dpm_2, k_dpm_2_ancestral, k_dpmpp_2s_ancestral, k_lms, k_dpmpp_2m, k_dpmpp_sde)
)

# Set up our warning to print to the console if the adult content classifier is tripped.
# If adult content classifier is not tripped, save generated images.
for resp in answers:
    for artifact in resp.artifacts:
        if artifact.finish_reason == generation.FILTER:
            warnings.warn(
                "Your request activated the API's safety filters and could not be processed."
                "Please modify the prompt and try again.")
        if artifact.type == generation.ARTIFACT_IMAGE:
            img = Image.open(io.BytesIO(artifact.binary))
            img.save(str(artifact.seed)+ ".png") # Save our generated images with their seed number as the filename.
```

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

### Remove Background Request in Python

Source: https://platform.stability.ai/docs/api-reference

Example of using the requests library to send an image for background removal.

```python
import requests

response = requests.post(
    f"https://api.stability.ai/v2beta/stable-image/edit/remove-background",
    headers={
        "authorization": f"Bearer sk-MYAPIKEY",
        "accept": "image/*"
    },
    files={
        "image": open("./husky-in-a-field.png", "rb")
    },
    data={
        "output_format": "webp"
    },
)

if response.status_code == 200:
    with open("./husky.webp", 'wb') as file:
        file.write(response.content)
else:
    raise Exception(str(response.json()))
```

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

### GET /v2beta/audio/results/{id}

Source: https://platform.stability.ai/docs/api-reference

Fetches the result of an audio generation by its ID. Poll this endpoint to check the status of an asynchronous generation.

```APIDOC
## GET /v2beta/audio/results/{id}

### Description
Fetch the result of an audio generation by ID. Poll this endpoint after starting an async audio generation. Returns 202 while in-progress, 200 with the audio when complete.

### Method
GET

### Endpoint
https://api.stability.ai/v2beta/audio/results/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The 64-character ID of the generation.

#### Header Parameters
- **authorization** (string) - Required - Your Stability API key.
- **accept** (string) - Optional - Specify 'audio/*' to receive bytes or 'application/json' for base64.

### Response
#### Success Response (200)
- **body** (binary) - The generated audio file content.

#### Success Response (202)
- **status** (string) - Generation is still in-progress.
```

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

### POST /v2beta/audio/stable-audio/text-to-audio

Source: https://platform.stability.ai/docs/api-reference

Initiates an asynchronous audio generation request based on a text prompt.

```APIDOC
## POST /v2beta/audio/stable-audio/text-to-audio

### Description
Initiates an asynchronous audio generation request. Returns a generation ID immediately with a 202 status code.

### Method
POST

### Endpoint
https://api.stability.ai/v2beta/audio/stable-audio/text-to-audio

### Request Body
- **prompt** (string) - Required - A description of the audio to generate.
- **output_format** (string) - Optional - The desired audio format (e.g., mp3).
- **duration** (integer) - Optional - The duration of the audio in seconds.

### Response
#### Success Response (202)
- **id** (string) - The unique identifier for the generation task.
```

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

### POST /

Source: https://platform.stability.ai/docs/api-reference

Generates an image based on a prompt and a control image style.

```APIDOC
## POST /

### Description
This endpoint extracts stylistic elements from an input image and uses them to guide the creation of an output image based on the provided prompt.

### Method
POST

### Endpoint
/

### Parameters
#### Header Parameters
- **authorization** (string) - Required - Your Stability API key.
- **accept** (string) - Optional - Specify `image/*` for raw bytes or `application/json` for base64 encoded JSON.
- **stability-client-id** (string) - Optional - The name of your application.
- **stability-client-user-id** (string) - Optional - A unique identifier for your end user.
- **stability-client-version** (string) - Optional - The version of your application.

#### Request Body (multipart/form-data)
- **prompt** (string) - Required - What you wish to see in the output image.
- **image** (binary) - Required - An image whose style you wish to use as the foundation.
- **negative_prompt** (string) - Optional - Text describing what you do not wish to see.
- **aspect_ratio** (string) - Optional - Controls the aspect ratio of the generated image.
- **fidelity** (number) - Optional - How closely the output image's style resembles the input image's style (0 to 1).
- **seed** (number) - Optional - A specific value to guide the randomness of the generation.
- **output_format** (string) - Optional - Dictates the format of the generated image (jpeg, png, webp).
- **style_preset** (string) - Optional - Guides the image model towards a particular style.
```

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

### Image-to-Image Generation Request Payload

Source: https://platform.stability.ai/docs/api-reference

Example JSON payload for an image-to-image generation request using 35% image strength.

```json
{
  "image_strength": 0.35,
  "init_image_mode": "IMAGE_STRENGTH",
  "init_image": "<image binary>",
  "text_prompts[0][text]": "A dog space commander",
  "text_prompts[0][weight]": 1,
  "cfg_scale": 7,
  "sampler": "K_DPM_2_ANCESTRAL",
  "samples": 3,
  "steps": 30
}
```

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

### POST /v2beta/audio/stable-audio-2/audio-to-audio

Source: https://platform.stability.ai/docs/api-reference

Transforms existing audio samples into new high-quality compositions using text instructions.

```APIDOC
## POST /v2beta/audio/stable-audio-2/audio-to-audio

### Description
Transforms existing audio samples into new high-quality compositions up to three minutes long at 44.1kHz stereo using text instructions.

### Method
POST

### Endpoint
https://api.stability.ai/v2beta/audio/stable-audio-2/audio-to-audio

### Parameters
#### Request Body (multipart/form-data)
- **prompt** (string) - Required - Text to generate the audio from
- **audio** (file) - Required - The audio to use as the starting point for the generation
- **output_format** (string) - Optional - The format of the output audio
- **seed** (integer) - Optional - The randomness seed to use for the generation
- **duration** (number) - Optional - The number of seconds of the generated audio
- **steps** (integer) - Optional - The number of sampling steps
- **mask_start** (number) - Optional - Start time in seconds for the audio segment to be inpainted
- **mask_end** (number) - Optional - End time in seconds for the audio segment to be inpainted

### Response
#### Success Response (200)
- **audio** (binary) - The bytes of the generated audio in the requested format
```

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

### POST /v2beta/audio/stable-audio-2/inpaint

Source: https://platform.stability.ai/docs/api-reference

Generates audio based on an input audio file and a text prompt using the Stable Audio 2.5 model.

```APIDOC
## POST /v2beta/audio/stable-audio-2/inpaint

### Description
Generates new audio by inpainting an existing audio file based on a provided prompt.

### Method
POST

### Endpoint
https://api.stability.ai/v2beta/audio/stable-audio-2/inpaint

### Parameters
#### Header Parameters
- **authorization** (string) - Required - Your Stability API key.
- **accept** (string) - Optional - Specify `audio/*` for raw bytes or `application/json` for base64 encoded JSON.
- **stability-client-id** (string) - Optional - The name of your application.
- **stability-client-user-id** (string) - Optional - A unique identifier for your end user.
- **stability-client-version** (string) - Optional - The version of your application.

#### Request Body (multipart/form-data)
- **prompt** (string) - Required - Descriptive text defining the desired output audio.
- **audio** (string/binary) - Required - The starting audio file (mp3 or wav, 6-190 seconds).
- **duration** (number) - Optional - Duration in seconds (1-190).
- **seed** (number) - Optional - Randomness seed (0-4294967294).
- **steps** (integer) - Optional - Number of sampling steps (4-8).
- **output_format** (string) - Optional - Format of the output (mp3 or wav).
- **mask_start** (number) - Optional - Start of the mask (0-190).
- **mask_end** (number) - Optional - End of the mask (0-190).

### Response
#### Success Response (200)
- **audio/mpeg or application/json** - The generated audio content.

#### Error Responses
- **400** - Invalid parameters.
- **403** - Content moderation flag.
- **422** - Request rejected.
- **429** - Rate limit exceeded.
- **500** - Internal server error.
```

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

### JSON Response Structure for Artifacts

Source: https://platform.stability.ai/docs/api-reference

Example of the JSON response body containing an array of artifacts with base64 encoded data and generation metadata.

```json
{
  "artifacts": [
    [
      {
        "base64": "...very long string...",
        "finishReason": "SUCCESS",
        "seed": 1050625087
},
      {
        "base64": "...very long string...",
        "finishReason": "CONTENT_FILTERED",
        "seed": 1229191277
}
]
]

}
```

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

### GET /v2beta/results/{id}

Source: https://platform.stability.ai/docs/api-reference

Fetch the result of a generation by its unique ID. Use the same API key used to create the generation to avoid a 404 error.

```APIDOC
## GET /v2beta/results/{id}

### Description
Fetch the result of a generation by ID. The generation is either in-progress (202) or complete (200).

### Method
GET

### Endpoint
https://api.stability.ai/v2beta/results/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The 64-character ID of the generation.

#### Header Parameters
- **authorization** (string) - Required - Your Stability API key.
- **accept** (string) - Optional - Specify `*/*` to receive raw bytes or `application/json` for base64 encoded JSON.
- **stability-client-id** (string) - Optional - The name of your application.
- **stability-client-user-id** (string) - Optional - A unique identifier for your end user.
- **stability-client-version** (string) - Optional - The version of your application.

### Response
#### Success Response (200)
- Generation finished.

#### In-Progress Response (202)
- Your generation is still in-progress.

#### Error Responses
- **400**: Invalid parameter(s).
- **404**: The generation does not exist or has expired.
- **500**: Internal server error.
```

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

### Perform audio-to-audio generation with Python

Source: https://platform.stability.ai/docs/api-reference

Sends a POST request to the audio-to-audio endpoint using the requests library. Requires an API key and a local audio file for input.

```python
import requests

response = requests.post(
    f"https://api.stability.ai/v2beta/audio/stable-audio-2/audio-to-audio",
    headers={"authorization": f"Bearer sk-MYAPIKEY", "accept": "audio/*"},
    files={
        "audio": open("./uk-bass-base.mp3", "rb"),
    },
    data={
        "prompt": "A song in the 3/4 time signature that features cheerful acoustic guitar, live recorded drums, and rhythmic claps, The mood is happy and up-lifting.",
        "output_format": "mp3",
        "duration": 20,
        "model": "stable-audio-2.5",
    },
)

if response.status_code == 200:
    with open("./output.mp3", "wb") as file:
        file.write(response.content)
else:
    raise Exception(str(response.json()))
```

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

### POST /v2beta/audio/stable-audio-2/audio-to-audio

Source: https://platform.stability.ai/docs/api-reference

Generates audio based on an input audio file and a text prompt.

```APIDOC
## POST /v2beta/audio/stable-audio-2/audio-to-audio

### Description
Generates audio using the Stable Audio models based on an input audio file and a descriptive prompt.

### Method
POST

### Endpoint
https://api.stability.ai/v2beta/audio/stable-audio-2/audio-to-audio

### Parameters
#### Header Parameters
- **authorization** (string) - Required - Your Stability API key.
- **content-type** (string) - Required - Must be multipart/form-data.
- **accept** (string) - Optional - Specify `audio/*` for raw bytes or `application/json` for base64 encoded JSON.
- **stability-client-id** (string) - Optional - The name of your application.
- **stability-client-user-id** (string) - Optional - A unique identifier for your end user.
- **stability-client-version** (string) - Optional - The version of your application.

#### Request Body
- **prompt** (string) - Required - Descriptive text defining the desired output audio.
- **audio** (string) - Required - The input audio file (mp3 or wav).
- **duration** (number) - Optional - Duration in seconds (1-190).
- **seed** (number) - Optional - Randomness guide (0-4294967294).
- **steps** (integer) - Optional - Number of sampling steps.
- **cfg_scale** (number) - Optional - Adherence to prompt (1-25).
- **model** (string) - Optional - Model to use (stable-audio-2, stable-audio-2.5).
- **output_format** (string) - Optional - Format of generated audio (mp3, wav).
- **strength** (number) - Optional - Influence of input audio (0-1).

### Response
#### Success Response (200)
- Generation was successful.
```

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

### Generate Audio with Python

Source: https://platform.stability.ai/docs/api-reference

Uses the requests library to send a multipart/form-data POST request to the Stable Audio endpoint and saves the resulting binary audio file.

```python
import requests

response = requests.post(
    f"https://api.stability.ai/v2beta/audio/stable-audio-2/text-to-audio",
    headers={"authorization": f"Bearer sk-MYAPIKEY", "accept": "audio/*"},
    files={"none": ""},
    data={
        "prompt": "A song in the 3/4 time signature that features cheerful acoustic guitar, live recorded drums, and rhythmic claps, The mood is happy and up-lifting.",
        "output_format": "mp3",
        "duration": 20,
        "model": "stable-audio-2.5",
    },
)

if response.status_code == 200:
    with open("./output.mp3", "wb") as file:
        file.write(response.content)
else:
    raise Exception(str(response.json()))
```

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

### Style Transfer Request in Python

Source: https://platform.stability.ai/docs/api-reference

Demonstrates how to perform a style transfer request using the requests library. Ensure the local image paths are correct before execution.

```python
import requests

response = requests.post(
    f"https://api.stability.ai/v2beta/stable-image/control/style-transfer",
    headers={
        "authorization": f"Bearer sk-MYAPIKEY",
        "accept": "image/*"
    },
    files={
        "init_image": open("./chicken-portrait.png", "rb"),
        "style_image": open("./glowbot.png", "rb")
    },
    data={
        "output_format": "webp"
    },
)

if response.status_code == 200:
    with open("./glow-chicken.webp", 'wb') as file:
        file.write(response.content)
else:
    raise Exception(str(response.json()))
```

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

### Generate Image with Inpainting

Source: https://platform.stability.ai/docs/features/inpainting?tab=typescript

Generate a new image using a prompt, an initial image, and a mask. Parameters like steps, cfg_scale, and sampler can be adjusted to control the generation process.

```python
answers = stability_api.generate(
    prompt="crayon drawing of rocket ship launching from forest",
    init_image=img,
    mask_image=mask,
    start_schedule=1,
    seed=44332211, # If attempting to transform an image that was previously generated with our API,
                   # initial images benefit from having their own distinct seed rather than using the seed of the original image generation.
    steps=50, # Amount of inference steps performed on image generation. Defaults to 30.
    cfg_scale=8.0, # Influences how strongly your generation is guided to match your prompt.
                   # Setting this value higher increases the strength in which it tries to match your prompt.
                   # Defaults to 7.0 if not specified.
    width=1024, # Generation width, if not included defaults to 512 or 1024 depending on the engine.
    height=1024, # Generation height, if not included defaults to 512 or 1024 depending on the engine.
    sampler=generation.SAMPLER_K_DPMPP_2M # Choose which sampler we want to denoise our generation with.
                                                 # Defaults to k_lms if not specified. Clip Guidance only supports ancestral samplers.
                                                 # (Available Samplers: ddim, plms, k_euler, k_euler_ancestral, k_heun, k_dpm_2, k_dpm_2_ancestral, k_dpmpp_2s_ancestral, k_lms, k_dpmpp_2m, k_dpmpp_sde)
)

# Set up our warning to print to the console if the adult content classifier is tripped.
# If adult content classifier is not tripped, save generated image.
for resp in answers:
    for artifact in resp.artifacts:
        if artifact.finish_reason == generation.FILTER:
            warnings.warn(
                "Your request activated the API's safety filters and could not be processed."
                "Please modify the prompt and try again.")
        if artifact.type == generation.ARTIFACT_IMAGE:
            global img2
            img2 = Image.open(io.BytesIO(artifact.binary))
            img2.save(str(artifact.seed)+ ".png") # Save our completed image with its seed number as the filename.
```

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

### Perform Search-and-Recolor with Python

Source: https://platform.stability.ai/docs/api-reference

Uses the requests library to send a multipart/form-data request to the API. Ensure the image file path is correct and the API key is properly configured.

```python
import requests

response = requests.post(
    f"https://api.stability.ai/v2beta/stable-image/edit/search-and-recolor",
    headers={
        "authorization": f"Bearer sk-MYAPIKEY",
        "accept": "image/*"
    },
    files={
        "image": open("./red-car.png", "rb")
    },
    data={
        "prompt": "a yellow car",
        "select_prompt": "car",
        "output_format": "webp",
    },
)

if response.status_code == 200:
    with open("./yellow-car.webp", 'wb') as file:
        file.write(response.content)
else:
    raise Exception(str(response.json()))
```

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

### POST /v2beta/audio/stable-audio/audio-to-audio

Source: https://platform.stability.ai/docs/api-reference

Generates audio based on an input audio file and a descriptive prompt. This endpoint requires 26 credits per successful generation.

```APIDOC
## POST /v2beta/audio/stable-audio/audio-to-audio

### Description
Generates new audio by applying a prompt to an existing audio file. The process is asynchronous; the endpoint returns a 202 status code, and the resulting ID should be used to poll for the final output.

### Method
POST

### Endpoint
https://api.stability.ai/v2beta/audio/stable-audio/audio-to-audio

### Parameters
#### Header Parameters
- **authorization** (string) - Required - Your Stability API key.
- **content-type** (string) - Required - Must be multipart/form-data.
- **accept** (string) - Optional - Specify `audio/*` for raw bytes or `application/json` for base64 encoded JSON.
- **stability-client-id** (string) - Optional - The name of your application.
- **stability-client-user-id** (string) - Optional - A unique identifier for your end user.
- **stability-client-version** (string) - Optional - The version of your application.

#### Request Body (multipart/form-data)
- **prompt** (string) - Required - Descriptive text defining the desired audio output.
- **audio** (binary) - Required - The starting audio file (mp3 or wav, 6-380 seconds).
- **model** (string) - Optional - The model to use (default: stable-audio-3).
- **duration** (number) - Optional - Duration in seconds (1-380, default: 190).
- **seed** (number) - Optional - Randomness seed (0-4294967294, default: 0).
- **steps** (integer) - Optional - Number of sampling steps (4-8, default: 8).
- **cfg_scale** (number) - Optional - Prompt adherence scale (1-25, default: 1).
- **output_format** (string) - Optional - Format of the output (mp3 or wav, default: mp3).
- **strength** (number) - Optional - Influence of input audio (0-1, default: 1).

### Response
#### Success Response (202)
- **id** (string) - The generation ID used for polling results.
```
Tokens:
Raw