텍스트로 이미지 API

텍스트로 이미지 API는 Meshy의 AI 이미지 생성 기능을 귀하의 애플리케이션에 통합할 수 있는 기능입니다. 강력한 AI 모델을 사용하여 텍스트 프롬프트로부터 고품질 이미지를 생성하세요.

POST/openapi/v1/text-to-image

텍스트로 이미지 작업 생성

이 엔드포인트는 새로운 텍스트로 이미지 작업을 생성할 수 있게 해줍니다. 텍스트로 이미지 작업 객체에 포함된 속성을 보려면 텍스트로 이미지 작업 객체를 참조하세요.

파라미터

  • Name
    ai_model
    Type
    string
    필수
    Description

    이미지 생성에 사용할 모델의 ID입니다.

    사용 가능한 값:

    • nano-banana: 표준 모델 (이미지당 3 크레딧)
    • nano-banana-2: 표준보다 강력한 기능을 가진 균형 모델 (이미지당 6 크레딧)
    • nano-banana-pro: 향상된 품질의 프로 모델 (이미지당 9 크레딧)
    • gpt-image-2: 고품질 이미지 모델인 OpenAI GPT Image 2 (이미지당 9 크레딧)
  • Name
    prompt
    Type
    string
    필수
    Description

    생성하고자 하는 이미지의 텍스트 설명입니다. 최상의 결과를 위해 상세히 기술하세요.

  • Name
    generate_multi_view
    Type
    boolean
    기본값 false
    Description

    true로 설정하면 여러 각도에서 피사체를 보여주는 멀티뷰 이미지를 생성합니다.

    generate_multi_view가 true일 때, aspect_ratio 파라미터는 설정할 수 없습니다.

  • Name
    pose_mode
    Type
    string
    Description

    캐릭터 생성에 대한 포즈 모드를 지정합니다. 생략하면 포즈 프리셋 없이 이미지가 생성됩니다.

    사용 가능한 값: a-pose, t-pose

  • Name
    aspect_ratio
    Type
    string
    기본값 1:1
    Description

    생성된 이미지의 가로세로 비율을 지정합니다. 허용되는 값은 선택한 ai_model에 따라 다릅니다:

    • nano-banana, nano-banana-2, nano-banana-pro: 1:1, 16:9, 9:16, 4:3, 3:4
    • gpt-image-2: 1:1, 16:9, 9:16, 3:2, 2:3

    사용 가능한 값:

    • 1:1: 정사각형 형식
    • 16:9: 와이드스크린 가로
    • 9:16: 와이드스크린 세로
    • 4:3: 표준 가로 (gpt-image-2에서 지원되지 않음)
    • 3:4: 표준 세로 (gpt-image-2에서 지원되지 않음)
    • 3:2: 가로 (gpt-image-2에서만 지원)
    • 2:3: 세로 (gpt-image-2에서만 지원)
  • Name
    remove_background
    Type
    boolean
    기본값 false
    Description

    true로 설정하면 생성된 이미지는 배경이 제거된 투명한 RGBA PNG로 반환되어, 피사체를 원하는 배경에 합성할 수 있습니다.

반환값

응답의 result 속성은 새로 생성된 텍스트로 이미지 작업의 작업 id를 포함합니다.

실패 모드

  • Name
    400 - Bad Request
    Description

    요청이 수용할 수 없는 상태입니다. 일반적인 원인:

    • 파라미터 누락: 필수 파라미터(예: ai_model, prompt)가 누락되었습니다.
    • 잘못된 파라미터: ai_model 또는 aspect_ratio가 허용된 값 중 하나가 아닙니다.
    • 충돌: generate_multi_view와 aspect_ratio는 동시에 사용할 수 없습니다.
  • Name
    401 - Unauthorized
    Description

    인증에 실패했습니다. API 키를 확인하세요.

  • Name
    402 - Payment Required
    Description

    이 작업을 수행하기에 충분한 크레딧이 없습니다.

  • Name
    429 - Too Many Requests
    Description

    속도 제한을 초과했습니다.

Request

POST
/openapi/v1/text-to-image
# Generate an image from a text prompt
curl https://api.meshy.ai/openapi/v1/text-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "A majestic dragon soaring through clouds at sunset",
    "aspect_ratio": "16:9"
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
GET/openapi/v1/text-to-image/:id

텍스트로 이미지 작업 가져오기

이 엔드포인트는 유효한 작업 id를 제공받아 텍스트로 이미지 작업을 가져올 수 있게 합니다. 텍스트로 이미지 작업 객체에 포함된 속성을 보려면 텍스트로 이미지 작업 객체를 참조하세요.

매개변수

  • Name
    id
    Type
    path
    Description

    가져올 텍스트로 이미지 작업의 고유 식별자입니다.

반환값

응답은 텍스트로 이미지 작업 객체를 포함합니다. 자세한 내용은 텍스트로 이미지 작업 객체 섹션을 확인하세요.

Request

GET
/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578
curl https://api.meshy.ai/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "expires_at": 1692771679037,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ]
}
DELETE/openapi/v1/text-to-image/:id

텍스트로 이미지 작업 삭제

이 엔드포인트는 텍스트로 이미지 작업과 관련된 모든 이미지 및 데이터를 영구적으로 삭제합니다. 이 작업은 되돌릴 수 없습니다.

경로 매개변수

  • Name
    id
    Type
    path
    Description

    삭제할 텍스트로 이미지 작업의 ID입니다.

반환값

성공 시 200 OK를 반환합니다.

Request

DELETE
/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 200 Ok on success.
GET/openapi/v1/text-to-image

텍스트로 이미지 작업 목록

이 엔드포인트를 사용하여 텍스트로 이미지 작업 목록을 가져올 수 있습니다.

매개변수

  • Name
    page_num
    Type
    integer
    Description

    페이지네이션을 위한 페이지 번호입니다. 1부터 시작하며 기본값입니다.

  • Name
    page_size
    Type
    integer
    Description

    페이지 크기 제한입니다. 기본값은 10 항목입니다. 허용되는 최대값은 50 항목입니다.

  • Name
    sort_by
    Type
    string
    Description

    정렬할 필드입니다. 사용 가능한 값:

    • +created_at: 생성 시간에 따라 오름차순으로 정렬합니다.
    • -created_at: 생성 시간에 따라 내림차순으로 정렬합니다.

반환값

텍스트로 이미지 작업 객체의 페이지네이션된 목록을 반환합니다.

Request

GET
/openapi/v1/text-to-image
curl https://api.meshy.ai/openapi/v1/text-to-image?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-image",
    "ai_model": "nano-banana",
    "prompt": "A majestic dragon soaring through clouds at sunset",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1692771650657,
    "started_at": 1692771667037,
    "finished_at": 1692771669037,
    "expires_at": 1692771679037,
    "image_urls": [
      "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
    ]
  }
]
GET/openapi/v1/text-to-image/:id/stream

텍스트로 이미지 작업 스트리밍

이 엔드포인트는 Server-Sent Events (SSE)를 사용하여 텍스트로 이미지 작업의 실시간 업데이트를 스트리밍합니다.

매개변수

  • Name
    id
    Type
    path
    Description

    스트리밍할 텍스트로 이미지 작업의 고유 식별자입니다.

반환값

Server-Sent Events로 텍스트로 이미지 작업 객체의 스트림을 반환합니다.

PENDING 또는 IN_PROGRESS 작업의 경우, 응답 스트림은 필요한 progress 및 status 필드만 포함합니다.

Request

GET
/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream
curl -N https://api.meshy.ai/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "expires_at": 1692771679037,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ]
}

텍스트로 이미지 작업 객체

텍스트로 이미지 작업 객체는 텍스트 prompt 입력으로부터 이미지를 생성하기 위해 Meshy가 추적하는 작업 단위입니다. 이 객체는 다음과 같은 속성을 가지고 있습니다:

속성

  • Name
    id
    Type
    string
    Description

    작업의 고유 식별자입니다. 우리는 작업 ID에 대해 k-sortable UUID를 구현 세부사항으로 사용하지만, ID의 형식에 대해 어떠한 가정도 하지 않아야 합니다.

  • Name
    type
    Type
    string
    Description

    이미지 생성 작업의 유형입니다. 텍스트로 이미지 작업의 경우, 항상 text-to-image가 됩니다.

  • Name
    ai_model
    Type
    string
    Description

    이 작업에 사용된 AI 모델입니다. 가능한 값은 nano-banana, nano-banana-2, nano-banana-pro, 또는 gpt-image-2입니다.

  • Name
    prompt
    Type
    string
    Description

    이미지를 생성하는 데 사용된 텍스트 prompt입니다.

  • Name
    status
    Type
    string
    Description

    작업의 상태입니다. 가능한 값은 PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED 중 하나입니다.

  • Name
    progress
    Type
    integer
    Description

    작업의 진행 상황입니다. 작업이 아직 시작되지 않은 경우, 이 속성은 0이 됩니다. 작업이 성공하면, 이는 100이 됩니다.

  • Name
    created_at
    Type
    timestamp
    Description

    작업이 생성된 시각의 타임스탬프입니다. 밀리초 단위입니다.

    타임스탬프는 1970년 1월 1일 UTC 이후 경과된 밀리초 수를 나타내며, RFC 3339 표준을 따릅니다. 예를 들어, 2023년 9월 1일 금요일 오후 12:00:00 GMT는 1693569600000으로 표현됩니다. 이는 Meshy API의 모든 타임스탬프에 적용됩니다.

  • Name
    started_at
    Type
    timestamp
    Description

    작업이 시작된 시각의 타임스탬프입니다. 밀리초 단위입니다. 작업이 아직 시작되지 않은 경우, 이 속성은 0이 됩니다.

  • Name
    finished_at
    Type
    timestamp
    Description

    작업이 완료된 시각의 타임스탬프입니다. 밀리초 단위입니다. 작업이 아직 완료되지 않은 경우, 이 속성은 0이 됩니다.

  • Name
    expires_at
    Type
    timestamp
    Description

    작업 결과가 만료되는 시각의 타임스탬프입니다. 밀리초 단위입니다.

  • Name
    preceding_tasks
    Type
    integer
    Description

    이전 작업의 수입니다.

    이 필드의 값은 작업 상태가 PENDING일 때만 의미가 있습니다.

  • Name
    image_urls
    Type
    array
    Description

    생성된 이미지의 다운로드 가능한 URL 배열입니다. generate_multi_view가 활성화된 경우, 이 배열은 서로 다른 시점의 세 가지 이미지 URL을 포함합니다. 그렇지 않으면, 단일 이미지 URL을 포함합니다.

  • Name
    task_error
    Type
    object
    Description

    실패한 작업에 대한 오류 세부사항입니다. 전체 task_error 객체 참조는 오류를 참조하세요.

  • Name
    consumed_credits
    Type
    integer
    Description

    이 작업에 소비된 크레딧의 수입니다. 작업 상태가 PENDING, IN_PROGRESS, 또는 SUCCEEDED일 때 나타납니다. FAILED 작업의 경우 0을 반환합니다 (실패 시 크레딧이 환불됩니다).

예제 텍스트로 이미지 작업 객체

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "expires_at": 1692771679037,
  "preceding_tasks": 0,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ],
  "task_error": {

    "message": ""

  },

  "consumed_credits": 3
}