# shortapi/transparent-image

> Elevate your creative workflow with ease. This tool lets you generate high-quality, ready-to-use graphics—like logos and icons—with true transparent backgrounds, eliminating the need for tedious background removal.

## Overview

- **Endpoint**: `https://api.shortapi.ai/api/v1/job/create`
- **Model ID**: `shortapi/transparent-image`
- **Category**: text-to-image
- **Kind**: inference

## Pricing

TURBO is $0.04, BALANCED is $0.08, and QUALITY is $0.12.

For more details, please check our pricing page.

## API Information

This model can be used via our HTTP API or more conveniently via our client libraries.
See the input and output schema below, as well as the usage examples.

### Input Schema

The API accepts the following input parameters:

- **`prompt`** (`string`, _required_):
  Text prompt
  - Examples: "An action shot of a black lab swimming..."

- **`negative_prompt`** (`string`, _optional_):
  Negative text prompt

- **`rendering_speed`** (`string`, _optional_):
  The rendering speed to use
  - Default: `TURBO`
  - Options: "TURBO", "BALANCED", "QUALITY"

- **`num_images`** (`int`, _optional_):
  The number of images to generate
  - Default: `1`
  - Range: `1` to `8`

- **`aspect_ratio`** (`string`, _optional_):
  The aspect ratio of the generated image
  - Default: `1:1`
  - Options: "1:3", "3:1", "1:2", "2:1", "9:16", "16:9", "10:16", "16:10", "2:3", "3:2", "3:4", "4:3", "4:5", "5:4", "1:1"

- **`expand_prompt`** (`bool`, _optional_):
  Determine if MagicPrompt should be used in generating the request or not
  - Default: `false`
  - Options: "true", "false"

### Output Schema

The API returns a JSON response with a `job_id` for tracking the request status.

**Create Job Response:**
```json
{
  "code": 0,
  "data": {
    "amount": "0.02",
    "job_id": "<JOB_ID>"
  }
}
```

**Query Job Result (when status is 2, meaning succeeded):**
```json
{
  "code": 0,
  "data": {
    "status": 2,
    "result": {
      "images": [{ "url": "https://..." }]
    }
  }
}
```

## Use Example

To use this model, make an HTTP POST request to the API endpoint, then poll for results using the returned `job_id`.

### Bash (cURL)
```bash
# Step 1: Create a job
response=$(curl --request POST \
  --url https://api.shortapi.ai/api/v1/job/create \
  --header "Authorization: Bearer $SHORTAPI_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "model": "shortapi/transparent-image",
  "args": {
    "prompt": "A low-poly 3D penguin standing upright, composed of black, white, and soft yellow geometric facets, clean angular planes defining its body and flippers, minimalistic style, soft ambient lighting, clean background, polygonal aesthetic"
  },
  "callback_url": "CALLBACK_URL"
}')
JOB_ID=$(echo "$response" | grep -o '"job_id": *"[^"]*"' | sed 's/"job_id": *//; s/"//g')

# Step 2: Poll for results
curl --request GET \
  --url "https://api.shortapi.ai/api/v1/job/query?id=$JOB_ID" \
  --header "Authorization: Bearer $SHORTAPI_KEY"
```

### JavaScript (Fetch API)
```javascript
// Step 1: Create a job
const response = await fetch(`https://api.shortapi.ai/api/v1/job/create`, {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${SHORTAPI_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "model": "shortapi/transparent-image",
    "args": {
      "prompt": "A low-poly 3D penguin standing upright, composed of black, white, and soft yellow geometric facets, clean angular planes defining its body and flippers, minimalistic style, soft ambient lighting, clean background, polygonal aesthetic"
    },
    "callback_url": "CALLBACK_URL"
})
});
const data = await response.json();
const JOB_ID = data.job_id;

// Step 2: Poll for results
const result = await fetch(`https://api.shortapi.ai/api/v1/job/query?id=${JOB_ID}`, {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${SHORTAPI_KEY}`
  }
});
const resultData = await result.json();
console.log(resultData);
```

### Python (Requests)
```python
import requests

# Step 1: Create a job
url = "https://api.shortapi.ai/api/v1/job/create"
payload = {
  "model": "shortapi/transparent-image",
  "args": {
    "prompt": "A low-poly 3D penguin standing upright, composed of black, white, and soft yellow geometric facets, clean angular planes defining its body and flippers, minimalistic style, soft ambient lighting, clean background, polygonal aesthetic"
  },
  "callback_url": "CALLBACK_URL"
}
headers = {
    "Authorization": f"Bearer {SHORTAPI_KEY}",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers, json=payload)
data = response.json()
JOB_ID = data.get("job_id")

# Step 2: Poll for results
result_url = f"https://api.shortapi.ai/api/v1/job/query?id={JOB_ID}"
result = requests.get(result_url, headers={"Authorization": f"Bearer {SHORTAPI_KEY}"})
print(result.json())
```