> ## 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. # 참조 이미지 업로드 초기화 > 최대 8 MiB의 JPG, PNG 또는 WebP 참조 이미지 업로드를 준비합니다. images_upload_sign_parts로 PUT URL을 받아 바이트를 업로드한 후 images_upload_complete를 호출하고, 생성 시 반환된 fileKey를 사용하세요. 최대 8 MiB의 JPG, PNG 또는 WebP 참조 이미지 업로드를 준비합니다. images\_upload\_sign\_parts로 PUT URL을 받아 바이트를 업로드한 후 images\_upload\_complete를 호출하고, 생성 시 반환된 fileKey를 사용하세요. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/images_upload_initialize ``` ## 인증 및 권한 이 헤더에 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}$`. contentType과 일치하는 확장자를 가진 이미지 파일명입니다. 최소 길이: 1. 최대 길이: 250. 패턴: `\.(?:jpe?g|png|webp)$`. 텍스트 값입니다. 허용값: "image/jpeg", "image/png", "image/webp". 정확한 바이트 단위 파일 크기이며, 최대 8 MiB입니다. 최솟값: 1. 최댓값: 8388608. 아래 JSON Schema는 검색을 통해 제공되는 정확한 필드 이름, 중첩 유형, 기본값, 범위 및 허용값을 유지합니다. 추가적인 필드 간 규칙은 작업 참고 사항에 나와 있습니다. ```json theme={null} { "type": "object", "properties": { "requestId": { "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.", "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}$" }, "filename": { "type": "string", "minLength": 1, "maxLength": 250, "pattern": "\\.(?:jpe?g|png|webp)$", "description": "The image filename, with an extension matching contentType." }, "contentType": { "type": "string", "enum": ["image/jpeg", "image/png", "image/webp"] }, "fileSize": { "type": "integer", "minimum": 1, "maximum": 8388608, "description": "Exact file size in bytes, up to 8 MiB." } }, "required": ["filename", "contentType", "fileSize"], "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_upload_initialize' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"85d80887-5e1c-4a86-bbad-bb105487f7e4","filename":"reference.png","contentType":"image/png","fileSize":7340032}' ``` ```javascript JavaScript theme={null} const input = { requestId: '85d80887-5e1c-4a86-bbad-bb105487f7e4', filename: 'reference.png', contentType: 'image/png', fileSize: 7340032, }; const response = await fetch('https://api.voicecheap.ai/v1/actions/images_upload_initialize', { 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_upload_initialize", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4", "filename": "reference.png", "contentType": "image/png", "fileSize": 7340032}, timeout=120, ) body = response.json() if not response.ok: raise RuntimeError(f"{body.get('code')}: {body.get('message')}") print(body) ``` ## 응답 성공한 첫 실행은 작업 결과를 data 아래에 포함하여 HTTP 200을 반환합니다. 재전송 시에는 저장된 요청 상태를 대신 반환할 수 있습니다. 예제는 지원되는 응답 중 하나를 보여주며 모든 선택 필드를 포함하지는 않습니다. 새 멀티파트 이미지 참조 업로드 세션, 생성될 객체 키, 바이트 단위의 파트 크기 및 최대 병렬 업로드 수입니다. 이 작업은 이미지 바이트를 업로드하거나 key를 생성에 사용할 수 있는 상태로 만들지 않습니다. ```json HTTP 200 theme={null} { "data": { "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "key": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png", "partSize": 5242880, "maxConcurrency": 4 }, "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4", "operation": "images_upload_initialize", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4", "operation": "images_upload_initialize", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "completed", "resultStored": false, "message": "The action completed. Retrieve its output from the corresponding history or resource action." }, "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4" } ``` ## 결과 필드 | 필드 | 설명 | | - | - | | `data.uploadId` | 활성 업로드 세션을 식별하는 UUID입니다. 나머지 업로드 액션에 전달하세요. | | `data.key` | 앞으로 생성될 소유 객체의 키입니다. 성공적으로 완료된 후 반환된 fileKey를 생성 참조로 사용하세요. | | `data.partSize` | 필수 파트 크기(바이트 단위)입니다. 단, 마지막 파트에는 남은 바이트가 포함됩니다. | | `data.maxConcurrency` | 권장 최대 동시 파트 업로드 수는 4입니다. | ## 이 요청 복구 및 폴링 연결이 끊어진 후에도 동일한 식별자를 사용하세요. 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":"85d80887-5e1c-4a86-bbad-bb105487f7e4","operation":"images_upload_initialize"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "85d80887-5e1c-4a86-bbad-bb105487f7e4", "operation": "images_upload_initialize", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "uploadId": "c547fb7f-f334-46a8-a8bb-80b5b343889a", "key": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png", "partSize": 5242880, "maxConcurrency": 4 } } } ``` ## 작업 참고 사항 * images:write가 필요하며 추가 업로드 범위는 필요하지 않습니다. * filename은 앞뒤 공백이 제거되며 1–250자여야 하고 .jpg, .jpeg, .png 또는 .webp로 끝나야 합니다. 확장자는 contentType의 image/jpeg, image/png 또는 image/webp와 일치해야 합니다. fileSize는 1부터 8,388,608까지의 정확한 정수 바이트 수입니다. * 공유 업로드 구현은 이 참조에 대해 partSize로 5 MiB(5,242,880바이트)를 반환합니다. 최대 5 MiB인 파일은 파트 하나를 사용하고, 그보다 크고 최대 8 MiB인 파일은 파트 두 개를 사용합니다. images\_upload\_sign\_parts로 PUT URL을 요청하고 바이트를 업로드한 다음 images\_upload\_complete를 호출하세요. * 완료 처리에서 반환된 fileKey를 images\_generate의 referenceImageKey로 사용하세요. initialize 결과는 fileKey가 아닌 key를 사용합니다. 완료 전에 key를 생성에 전달하지 마세요. * 프로덕션 업로드 세션은 24시간 후에 만료됩니다. 서명된 파트 URL은 한 시간 후에 만료됩니다. 완료와 중단은 활성 세션을 제거하며, 이후 sign-parts와 complete는 Upload not found를 반환합니다. 어느 응답에도 expiresAt 필드는 포함되지 않습니다. * 인증 정보가 팀 컨텍스트로 연결되어 있어도 이 액션은 연결된 사용자 본인의 생성물과 업로드를 사용합니다. * UUID v4 requestId 또는 HTTP Idempotency-Key 헤더를 사용하고 재시도 시 동일한 입력과 함께 재사용하세요. 통합 계층은 각 변경을 기록하고 다시 실행하지 않은 채 기록된 상태 또는 결과를 반환합니다. failed 또는 interrupted 상태의 요청은 자동으로 재시도되지 않습니다. * 객체 키의 파일명은 안전하게 정리되며 짧아질 수 있습니다. 반환된 key와 uploadId를 정확히 보관하고 직접 구성하지 마세요. 업로드 시 선언된 크기와 유형을 검증하는 것에 더해, 생성 중에도 이미지 바이트를 검증합니다. ## 사용량 성공한 호출마다 월간 API/MCP 호출 1회가 차감됩니다. 미디어 크레딧과 해당 작업의 생성 허용량도 적용됩니다. ## 오류 | HTTP 상태 | 코드 | 의미 또는 복구 방법 | | - | - | - | | 400 | `CREDENTIAL_IN_QUERY` | 자격 증명이 access\_token 또는 api\_key 쿼리 매개변수로 제공되었습니다. 자격 증명은 헤더로 보내세요. | | 400 | `IDEMPOTENCY_CONFLICT` | Idempotency-Key 헤더와 본문의 requestId 필드가 일치해야 합니다. | | 400 | `INVALID_REQUEST_ID` | requestId 또는 Idempotency-Key가 UUID v4가 아닙니다. | | 400 | `REFERENCE_IMAGE_INVALID` | 파일 이름 확장자가 선언된 이미지 contentType과 일치하지 않습니다. | | 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을 반환합니다. | | 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 월간 한도가 초기화될 때까지 기다리거나 요금제를 변경하세요. | | 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Retry-After가 있으면 지정된 시간만큼 기다리고 백오프를 적용하세요. | | 500 | `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.