> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# 이미지 생성
> 연결된 계정에 이미지를 생성합니다. 웹 앱과 동일한 미디어 허용량 및 보호 장치를 적용합니다. 반환된 generationId를 저장하고 images_download로 이미지를 조회하세요. 동일한 요청을 재시도할 때는 requestId를 재사용하세요.
연결된 계정에 이미지를 생성합니다. 웹 앱과 동일한 미디어 허용량 및 보호 장치를 적용합니다. 반환된 generationId를 저장하고 images\_download로 이미지를 조회하세요. 동일한 요청을 재시도할 때는 requestId를 재사용하세요.
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/images_generate
```
## 인증 및 권한
이 헤더에 VoiceCheap API 키를 전달하세요. 동일한 API 키를 사용하는 Authorization: Bearer도 지원합니다. OAuth 액세스 토큰은 MCP에서만 허용되며, 이
REST 엔드포인트에서는 사용할 수 없습니다.
필요한 권한: `images:write`.
활성 유료 구독이 필요합니다. 권한은 팀 역할, 리소스 소유권, 미디어 크레딧 또는 요금제 한도를 변경하지 않습니다.
## 매개변수
전송 계층에서는 선택 사항입니다. 생략하면 서버가 유효성 검사 전에 식별자를 추가합니다. 응답이 유실된 경우 안전하게 복구할 수 있도록 고정된 UUID v4를 직접 제공하세요.
형식: "uuid". 패턴: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$`.
텍스트 값입니다.
최소 길이: 10. 최대 길이: 1200.
텍스트 값입니다.
허용값: "square", "landscape", "portrait". 기본값: "square".
uploads/\{yourUserId}/ 아래에 업로드된 JPG, PNG 또는 WebP 객체 키입니다. 원격 URL은 허용되지 않습니다.
최소 길이: 1. 최대 길이: 512.
아래 JSON Schema는 검색을 통해 제공되는 정확한 필드 이름, 중첩 유형, 기본값, 범위 및 허용값을 유지합니다. 추가적인 필드 간 규칙은 작업 참고 사항에 나와 있습니다.
```json theme={null}
{
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
},
"prompt": {
"type": "string",
"minLength": 10,
"maxLength": 1200
},
"aspectRatio": {
"default": "square",
"type": "string",
"enum": ["square", "landscape", "portrait"]
},
"referenceImageKey": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"description": "An uploaded JPG, PNG or WebP object key under uploads/{yourUserId}/. Remote URLs are not accepted."
}
},
"required": ["prompt"],
"additionalProperties": false
}
```
## 멱등성
각 변경 작업에 대해 requestId 또는 Idempotency-Key HTTP 헤더에 UUID v4를 사용하세요. 네트워크 오류 후에는 동일한 식별자와 동일한 인수를 재사용하세요. 둘 다 제공하는 경우 값이 일치해야 합니다. 저장된 요청을 재전송해도 작업이 반복되거나 월간 호출이 추가로 차감되지 않습니다. 실패하거나 중단된 요청은 자동으로 다시 시작되지 않습니다.
첫 실행이 일반적으로 동기식인 경우에도, 재시도 시 동일한 요청이 아직 실행 중이면 모든 변경 작업에서 HTTP 202를 반환할 수 있습니다. 실행은 완료되었지만 resultStored가 false이면, 재시도 시 원래 결과 대신 저장된 요청 상태를 HTTP 200으로 반환합니다. 해당 영역의 기록, 결과 또는 다운로드 액션으로 출력을 조회하세요.
## 요청 예제
예제의 리소스 식별자와 미디어 키를 계정에서 반환된 값으로 바꾸세요. 동일한 변경 작업을 재시도할 때는 요청 식별자를 유지하세요.
```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/images_generate' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"61becb70-00d6-4de0-9eb1-05829a0d851c","prompt":"A peaceful coastal village at sunrise, with warm natural light.","aspectRatio":"square","referenceImageKey":"uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png"}'
```
```javascript JavaScript theme={null}
const input = {
requestId: '61becb70-00d6-4de0-9eb1-05829a0d851c',
prompt: 'A peaceful coastal village at sunrise, with warm natural light.',
aspectRatio: 'square',
referenceImageKey: 'uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/images_generate', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
```
```python Python theme={null}
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/images_generate",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c", "prompt": "A peaceful coastal village at sunrise, with warm natural light.", "aspectRatio": "square", "referenceImageKey": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```
## 응답
이 작업은 실행 중에 HTTP 202를 반환합니다. requestId를 저장하고 해당 식별자와 원래 작업 이름으로 action\_request\_get을 폴링하세요. 폴링 상태는 running, completed, failed, interrupted입니다. 완료된 결과가 별도의 미디어 작업을 가리킬 수 있으므로 해당 작업의 상태 또는 출력 액션을 이어서 사용하세요.
이미지 생성 완료 후 핸들러가 반환하는 최종 생성 메타데이터입니다. 이미지 바이트, previewDataUrl 또는 다운로드 URL은 포함되지 않습니다.
```json HTTP 202 theme={null}
{
"data": {
"requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c"
}
```
```json HTTP 200 theme={null}
{
"data": {
"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
"status": "completed",
"aspectRatio": "square",
"width": 1024,
"height": 1024,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"expiresAt": 1792749600000
},
"requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c"
}
```
```json HTTP 202 replay_running theme={null}
{
"data": {
"requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c",
"operation": "images_generate",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c"
}
```
```json HTTP 200 replay_completed_without_result theme={null}
{
"data": {
"requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c",
"operation": "images_generate",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c"
}
```
## 결과 필드
| 필드 | 설명 |
| - | - |
| `data.generationId` | 변경하지 않고 images\_get 또는 images\_download에 전달할 식별자입니다. |
| `data.status` | pending, completed, failed 또는 expired입니다. 만료 여부가 저장된 상태보다 우선합니다. |
| `data.aspectRatio` | square, landscape 또는 portrait입니다. |
| `data.width` | 픽셀 단위 출력 너비이며, 크기를 확인할 수 있기 전에는 null입니다. |
| `data.height` | 출력 높이의 픽셀 값입니다. 크기 정보를 사용할 수 있기 전에는 null입니다. |
| `data.referenceImageCount` | 사용한 참조 이미지 수: 0 또는 1입니다. |
| `data.createdAt` | Unix 밀리초 단위의 생성 시각입니다. |
| `data.updatedAt` | 마지막 업데이트 시각으로, Unix 밀리초 단위입니다. |
| `data.expiresAt` | 생성된 이미지를 더 이상 다운로드할 수 없게 되는 시간이며, Unix 밀리초 단위입니다. |
## 이 요청 복구 및 폴링
연결이 끊어진 후에도 동일한 식별자를 사용하세요. resultStored가 false이면 해당 기록, 결과 또는 다운로드 액션을 통해 출력을 조회하세요. 진행 상황을 확인하기 위해 두 번째 생성을 시작하지 마세요.
```bash theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"61becb70-00d6-4de0-9eb1-05829a0d851c","operation":"images_generate"}'
```
```json HTTP 200 theme={null}
{
"data": {
"requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c",
"operation": "images_generate",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c",
"status": "completed",
"aspectRatio": "square",
"width": 1024,
"height": 1024,
"referenceImageCount": 1,
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"expiresAt": 1792749600000
}
}
}
```
## 작업 참고 사항
* images:write가 필요합니다. 프롬프트는 앞뒤 공백을 제거한 후 10\~1200자여야 하며, 생성 전에도 정규화됩니다. aspectRatio의 기본값은 square이며 landscape 또는 portrait도 허용합니다. referenceImageKey는 최대 하나만 허용됩니다.
* 장시간 실행되는 액션입니다. 최초 API/MCP 응답은 일반적으로 running을 나타냅니다. 여기에 표시된 최종 결과를 얻으려면 operation을 images\_generate로 설정하고 동일한 requestId를 사용하여 action\_request\_get을 폴링하세요.
* 계정의 일반 일일 이미지 생성 허용량을 사용합니다. 계정에서 생성한 이미지는 생성 후 7일이 지나면 만료됩니다. expiresAt 전에 결과를 다운로드하세요.
* 인증 정보가 팀 컨텍스트로 연결되어 있어도 이 액션은 연결된 사용자 본인의 생성물과 업로드를 사용합니다.
* 참조 키는 uploads/\{yourUserId}/ 아래의 완료된 업로드를 가리켜야 하며 .jpg, .jpeg, .png 또는 .webp로 끝나야 합니다. 원격 URL, 다른 사용자의 키, 경로 탐색 세그먼트, 역슬래시, 퍼센트 이스케이프, 쿼리 문자열, 프래그먼트 및 제어 문자는 허용되지 않습니다.
* 각 참조는 비어 있지 않아야 하며 최대 8 MiB(8,388,608바이트)여야 합니다. 확장자가 나타내는 이미지 유형으로 디코딩되어야 하며 가로와 세로가 각각 128–4096픽셀이어야 합니다. 디코딩된 픽셀 수에도 한도가 적용됩니다. 업로드된 참조는 재사용할 수 있으며, 이 생성 액션들은 업로드된 파일을 소모하거나 삭제하지 않습니다.
* UUID v4 requestId 또는 HTTP Idempotency-Key 헤더를 사용하고 재시도 시 동일한 입력과 함께 재사용하세요. 통합 계층은 각 변경을 기록하고 다시 실행하지 않은 채 기록된 상태 또는 결과를 반환합니다. failed 또는 interrupted 상태의 요청은 자동으로 재시도되지 않습니다.
* 이 사용자는 한 번에 이미지 하나만 생성할 수 있습니다. 생성 상태는 images\_list와 images\_get으로 확인하고, PNG 바이트는 images\_download로 받으세요. 생성 식별자는 불투명 문자열입니다. requestId로 대체하지 마세요.
## 사용량
성공한 호출마다 월간 API/MCP 호출 1회가 차감됩니다. 미디어 크레딧과 해당 작업의 생성 허용량도 적용됩니다.
## 오류
| HTTP 상태 | 코드 | 의미 또는 복구 방법 |
| - | - | - |
| 400 | `BAD_REQUEST` | 서버가 신뢰할 수 있는 요청 네트워크 컨텍스트를 확인하지 못했습니다. |
| 400 | `CREDENTIAL_IN_QUERY` | 자격 증명이 access\_token 또는 api\_key 쿼리 매개변수로 제공되었습니다. 자격 증명은 헤더로 보내세요. |
| 400 | `IDEMPOTENCY_CONFLICT` | Idempotency-Key 헤더와 본문의 requestId 필드가 일치해야 합니다. |
| 400 | `IMAGE_PROMPT_INVALID` | 정규화된 프롬프트가 10–1200자 범위를 벗어났습니다. |
| 400 | `IMAGE_REFERENCE_INVALID` | 참조 바이트가 지원되는 이미지 유형, 바이트 한도, 이미지 치수 또는 디코딩 요구 사항을 충족하지 않습니다. |
| 400 | `INVALID_REQUEST_ID` | requestId 또는 Idempotency-Key가 UUID v4가 아닙니다. |
| 400 | `REFERENCE_IMAGE_INVALID` | 참조 키가 안전하지 않거나, 소유권이 없거나, 지원되지 않거나, 사용할 수 없거나, 8 MiB보다 큽니다. |
| 400 | `VALIDATION_ERROR` | 인수가 누락되었거나, 지원하지 않는 값이거나, 제한을 초과했거나, 엄격한 입력 스키마에 포함되지 않습니다. |
| 401 | `API_KEY_EXPIRED` | API 키가 만료되었습니다. |
| 401 | `INVALID_API_KEY` | 유효하고 만료되지 않은 API 키를 제공하세요. |
| 401 | `INVALID_CREDENTIAL` | Authorization 헤더의 형식이 잘못되었거나 x-api-key와 충돌합니다. |
| 401 | `MISSING_CREDENTIAL` | 사용 가능한 헤더 자격 증명이 전달되지 않았거나 4096자를 초과했습니다. |
| 401 | `USER_NOT_FOUND` | 이 자격 증명에 연결된 계정이 더 이상 존재하지 않습니다. |
| 403 | `ACCOUNT_UNAVAILABLE` | 작업을 수행하는 계정 또는 결제 계정을 사용할 수 없거나 해당 계정이 삭제 중입니다. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | 이 자격 증명의 사용자가 둘 이상의 팀에 속해 있어 청구 컨텍스트가 모호합니다. |
| 403 | `INSUFFICIENT_SCOPE` | 필요한 모든 권한을 부여하거나 다른 자격 증명을 사용하세요. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | 계정의 통합 한도를 확인할 수 없습니다. |
| 403 | `SUBSCRIPTION_REQUIRED` | 활성 유료 구독을 사용하세요. |
| 403 | `TEAM_OWNER_NOT_FOUND` | 실제로 적용되는 팀 소유자 계정을 찾을 수 없습니다. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | 이 계정에서는 이미 10개의 연동 액션이 실행 중입니다. 새 액션을 시작하기 전에 기존 요청을 폴링하세요. |
| 409 | `IDEMPOTENCY_CONFLICT` | 이 요청 식별자는 이미 다른 인수와 함께 사용되었습니다. 헤더와 본문의 식별자가 일치하지 않으면 동일한 코드와 함께 HTTP 400을 반환합니다. |
| 409 | `IMAGE_GENERATION_IN_PROGRESS` | 이 이미지 요청 또는 연결된 사용자의 다른 이미지 요청이 아직 running 상태입니다. |
| 409 | `IMAGE_REQUEST_ID_REUSED` | 이미지 요청 식별자가 이미 다른 입력과 연결되어 있습니다. |
| 422 | `IMAGE_REQUEST_REJECTED` | 이 프롬프트 또는 참조로 이미지를 생성할 수 없습니다. 새 요청을 위해 콘텐츠를 변경하세요. |
| 429 | `IMAGE_DAILY_LIMIT_REACHED` | 계정의 일일 이미지 생성 허용량을 모두 소모했습니다. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 월간 한도가 초기화될 때까지 기다리거나 요금제를 변경하세요. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Retry-After가 있으면 지정된 시간만큼 기다리고 백오프를 적용하세요. |
| 500 | `INTERNAL_ERROR` | 변경 작업을 재시도하기로 결정하기 전에 저장된 요청 상태와 리소스 기록을 확인하세요. |
| 502 | `INTERNAL_ERROR` | 이미지 생성 또는 준비에 실패했습니다. 다른 생성을 시작하기 전에 요청 상태를 확인하세요. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | 액션은 실행되었지만 결과를 저장할 수 없습니다. 새 생성을 시작하기 전에 저장된 요청 상태와 리소스 기록을 확인하세요. |
| 503 | `INTERNAL_ERROR` | 이미지 생성 또는 저장된 결과를 일시적으로 사용할 수 없습니다. 다시 시도하기 전에 요청 상태를 확인하세요. |
| 503 | `SERVER_RESTARTING` | 서버가 다시 시작 중입니다. 잠시 후 재시도하고, 변경 작업의 경우 동일한 요청 식별자를 유지하세요. |
```json theme={null}
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["images:write"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.