lowpoly は 2026/10/30 に廃止されます。 リクエストエラーを避けるため、これらの日付までにモデルを切り替えてください。 非推奨の一覧を見る

Creative Lab フィギュア API

写真を2段階でチビ風のコレクタブル3Dフィギュアに変換します。プロトタイプタスクは写真からコンセプト画像を生成します。ビルドタスクはその画像をテクスチャ付きの3Dモデルに変換し、プロトタイプタスクのIDを input_task_id として受け取ります。

  • POST /openapi/creative-lab/figure/v1/prototype
  • POST /openapi/creative-lab/figure/v1/build

POST/openapi/creative-lab/figure/v1/prototype

フィギュアのプロトタイプタスクを作成する

写真からちびキャラ風のコンセプト画像を1枚生成します。3Dモデルを作成するには、このタスクのIDをinput_task_idとしてbuildエンドポイントに渡してください。タスクのフィールドについては、フィギュアのプロトタイプタスクオブジェクトを参照してください。

Request

POST
/openapi/creative-lab/figure/v1/prototype
# Stage 1: generate a chibi-style concept image
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>"
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
Prototype example
Start with a source portrait, then generate the prototype image used by the build stage.
Source portrait used as the Creative Lab Figure input
Prototype input
Chibi-style figurine prototype image generated from the source photo
Prototype output

パラメーター

  • Name
    image_url
    Type
    string
    必須
    Description

    フィギュア(ちびキャラ)に変換する写真を、公開URLまたはData URI(data:image/jpeg;base64,<your base64-encoded image data>)として指定します。

    画像はJPG、JPEG、PNG、またはWebPファイルで、最大20MBまでです。

  • Name
    name
    Type
    string
    Description

    タスクの名前です。最大100文字まで指定できます。タスクのnameフィールドに返されます。これより長い名前を指定すると400が返されます。

  • Name
    remove_background
    Type
    boolean
    デフォルト false
    Description

    プロトタイプ画像から背景を除去するかどうかを指定します。trueにすると、透過RGBA PNGが返されるため、被写体を任意の背景に配置できます。buildも背景を除去した画像から開始されます。Meshyが背景を除去できない場合、背景付きの画像が返されますが、タスク自体は成功として扱われます。

レスポンス

resultフィールドには、新しいプロトタイプタスクのIDが入ります。statusがSUCCEEDEDになるまでタスクを取得するか、ストリーミングで取得してください。その後、そのIDをinput_task_idとしてbuildエンドポイントに渡します。

失敗パターン

  • Name
    400 - Bad Request
    Description

    リクエストを実行できません。例えば次のような場合です。

    • image_urlが指定されていない。
    • 画像がJPG、JPEG、PNG、またはWebPファイルではない。
    • 画像が小さすぎる、20MBを超えている、または最大ピクセル数を超えている。
    • Meshyが画像をダウンロードできない(例:URLが404を返す、またはタイムアウトする)。
    • Data URIが有効なbase64ではない。
    • 画像がNSFWとしてフラグ付けされた。

    エラーメッセージには、検出された問題の内容が示されます。リクエストを修正してから、再度送信してください。

  • Name
    401 - Unauthorized
    Description

    APIキーが指定されていないか、無効です。Authorizationヘッダーを確認してください。

  • Name
    402 - Payment Required
    Description

    次のいずれかに該当します。

    • アカウントのクレジットが不足している。
    • APIキー、ワークスペース、またはメンバーがクレジット上限に達した。
    • アカウントが無料プランである。

    クレジットとプランを確認してから、再試行してください。

  • Name
    403 - Forbidden
    Description

    あなたのチームでIPフィルタリングが有効になっており、Meshyがその画像を第三者の知的財産としてフラグ付けしました。使用する権利を持つ画像を送信してください。

  • Name
    429 - Too Many Requests
    Description

    次のいずれかの上限に達しました。

    • レート制限で許可されている数を超えるリクエストを送信した。数秒待ってから再試行してください。レート制限を参照してください。
    • キューに入っている、または実行中のタスクが多すぎる。いくつか完了するのを待ってから再試行してください。
    • クレジットが残っていない無制限プランで、クレジットなしで実行できるタスク数の上限に達した。タスクが完了するのを待つか、クレジットを追加してください。
  • Name
    500 - Internal Server Error
    Description

    Meshyでサーバーエラーが発生しました。例えば、画像に対する知的財産チェックを実行できなかった場合などです。Meshyはタスクを作成せず、課金されたクレジットがあれば返金します。リクエストを再試行してください。


POST/openapi/creative-lab/figure/v1/build

フィギュアビルドタスクを作成する

成功したプロトタイプタスクから、テクスチャ付きの3Dフィギュアを生成します。そのフィールドについては、The Figure build task objectを参照してください。

Request

POST
/openapi/creative-lab/figure/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}
ビルドの例
ビルドタスクは、選択したプロトタイプ画像をダウンロード可能なテクスチャ付き3Dモデルに変換します。
Creative Lab Figure build model preview
Build model preview

パラメータ

  • Name
    input_task_id
    Type
    string
    必須
    Description

    ビルドするプロトタイプタスクのIDです。POST /openapi/creative-lab/figure/v1/prototypeでお客様のアカウントが作成した、ステータスがSUCCEEDEDのタスクである必要があります。

    APIから作成したFigureプロトタイプタスクのいずれとも一致しないIDの場合、ウェブアプリで作成されたプロトタイプを含め、404が返されます。

  • Name
    name
    Type
    string
    Description

    タスクの名前で、最大100文字です。タスクのnameフィールドに返されます。これより長い名前を指定すると400が返されます。

戻り値

resultフィールドには、新しいビルドタスクのIDが格納されます。statusがSUCCEEDEDになるまでタスクを取得するか、ストリーミングするかしてください。その後、model_urls.glbからテクスチャ付きのGLBをダウンロードします。OBJが必要な場合は、model_urls.objとそのマテリアルファイルをmodel_urls.mtlからダウンロードしてください。

失敗モード

  • Name
    400 - Bad Request
    Description

    リクエストを実行できません。例えば次のような場合です。

    • input_task_idが指定されていない、または有効なタスクIDではない。
    • プロトタイプタスクのステータスがSUCCEEDEDではない。まだ実行中の場合は、しばらく待ってから再試行してください。失敗またはキャンセルされた場合は、新しいプロトタイプタスクを作成してください。
    • プロトタイプタスクは成功したが、画像がない。新しいプロトタイプタスクを作成してください。

    エラーメッセージには、どの問題が検出されたかが示されます。

  • Name
    401 - Unauthorized
    Description

    APIキーが指定されていないか、無効です。Authorizationヘッダーを確認してください。

  • Name
    402 - Payment Required
    Description

    以下のいずれかに該当します。

    • アカウントのクレジットが不足している。
    • APIキー、ワークスペース、またはメンバーがクレジット上限に達した。
    • アカウントが無料プランである。

    クレジットとプランを確認してから、再試行してください。

  • Name
    404 - Not Found
    Description

    input_task_idが、お客様のアカウントがAPIで作成したどのFigureプロトタイプタスクとも一致しません。ウェブアプリで作成されたプロトタイプの場合も404が返されます。プロトタイプ作成レスポンスのresult IDを送信してください。

  • Name
    429 - Too Many Requests
    Description

    以下のいずれかの上限に達しました。

    • レート制限で許可されている数より多くのリクエストを送信した。数秒待ってから再試行してください。Rate limitsを参照してください。
    • キューに入っている、または実行中のタスクが多すぎる。いくつか完了するのを待ってから再試行してください。
    • クレジットが残っていない無制限プランで、クレジットなしで実行できるタスク数に達した。タスクが完了するのを待つか、クレジットを追加してください。

GET/openapi/creative-lab/figure/v1/(prototype|build)/:id

Figureタスクを取得する

prototypeタスクまたはbuildタスクを返します。パスはタスクのステージと一致している必要があります。/prototype/:id を通じてリクエストされたbuildタスクは 404 を返し、/build/:id を通じてリクエストされたprototypeタスクも同様に 404 を返します。

フィールドについては、Figure prototypeタスクオブジェクトとFigure buildタスクオブジェクトを参照してください。

Request

GET
/openapi/creative-lab/figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
# Prototype
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}

パラメータ

  • Name
    id
    Type
    path
    Description

    作成レスポンスのタスクIDです。

返り値

パス内のステージに対応した、prototypeタスクオブジェクトまたはbuildタスクオブジェクトです。

失敗モード

  • Name
    400 - Bad Request
    Description

    id が有効なタスクIDではありません。作成レスポンスの result IDを送信してください。

  • Name
    403 - Forbidden
    Description

    チームでIPフィルタリングが有効になっており、Meshyがタスクの画像をサードパーティの知的財産として検出しました。Enterpriseプランのチームでは、このエラーは発生しません。使用権を持っている画像からprototypeタスクを作成してください。

  • Name
    404 - Not Found
    Description

    このIDを持つFigureタスクがアカウントに存在しないか、タスクのステージがパスと一致していません。IDを確認し、タスクに合わせて /prototype または /build を使用してください。

  • Name
    500 - Internal Server Error
    Description

    Meshyが知的財産チェックを実行できませんでした。リクエストを再試行してください。


DELETE/openapi/creative-lab/figure/v1/(prototype|build)/:id

Figure タスクを削除する

Figure タスクをキャンセルします。PENDING のタスクをキャンセルすると、クレジットが返金されます。IN_PROGRESS のタスクは、すでにワーカーが処理を開始しているため、返金なしでキャンセルされます。最終ステータス(SUCCEEDED、FAILED、CANCELED)のタスクはキャンセルできません。

パスはタスクのステージと一致している必要があります。たとえば、ビルドタスクの ID を使って /prototype/:id に対して DELETE を実行すると 404 が返されます。

Request

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

Response

// Returns 204 No Content on success (empty body).

パスパラメーター

  • Name
    id
    Type
    path
    Description

    キャンセルするタスクの ID。

戻り値

空のボディを伴う 204 No Content。

失敗モード

  • Name
    400 - Bad Request
    Description

    以下のいずれかに該当します:

    • id が有効なタスク ID ではありません。作成レスポンスの result の ID を送信してください。
    • タスクがすでに最終ステータス(SUCCEEDED、FAILED、CANCELED)になっているため、キャンセルできません。
  • Name
    404 - Not Found
    Description

    この ID の Figure タスクがあなたのアカウントに存在しないか、タスクのステージがパスと一致していません。ID を確認し、タスクに合わせて /prototype または /build を使用してください。


GET/openapi/creative-lab/figure/v1/(prototype|build)/:id/stream

Figureタスクをストリーミングする

Figureタスクの更新をServer-Sent Events(SSE)としてストリーミングします。パスはタスクのステージと一致している必要があります。一致しない場合、例えばbuildタスクのIDを/prototype/:id/streamに指定した場合、ストリームはstatus_code: 404を持つ1つのerrorイベントを送信してからクローズします。

Request

GET
/openapi/creative-lab/figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream
curl -N https://api.meshy.ai/openapi/creative-lab/figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (wrong stage or task not found)
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// Every frame is the full task object; fields not yet populated are null / empty.
// The following PENDING frame is shortened to the fields that change.
event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-figure-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}

パラメータ

  • Name
    id
    Type
    path
    Description

    作成時のレスポンスから取得したタスクIDです。

戻り値

prototypeまたはbuildタスクオブジェクトのストリームです。各イベントには、Figureタスクを取得するが返すのと同じ、完全なタスクオブジェクトが含まれます。タスクがPENDINGまたはIN_PROGRESSの間は、出力フィールドはまだ空(null、[]、または{})であり、finished_atはnullです。

IPフィルタリングによってタスクの結果がブロックされた場合、ストリームはその代わりに、GETリクエストが返すであろうstatus_codeを持つ1つのerrorイベントを送信します。


GET/openapi/creative-lab/figure/v1/(prototype|build)

Figureタスクの一覧を取得

1つのステージのFigureタスクを、1ページずつ返します。パスでステージを選択します。/prototype はプロトタイプタスクのみを返し、/build はビルドタスクのみを返します。

Request

GET
/openapi/creative-lab/figure/v1/prototype
# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-figure-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729123456000,
    "started_at": 1729123460000,
    "finished_at": 1729123486000,
    "expires_at": 1729382686000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

パスパラメータ

  • Name
    stage
    Type
    path
    必須
    Description

    一覧を取得するステージ。prototype または build。

クエリパラメータ

  • Name
    page_num
    Type
    integer
    デフォルト 1
    Description

    返すページ。1 から 255 まで。0 を指定すると最初のページが返されます。0 から 255 の範囲外の値を指定すると 400 が返されます。

  • Name
    page_size
    Type
    integer
    デフォルト 10
    Description

    1ページあたりのタスク数。最大 100。101 から 255 の値を指定すると100件のタスクが返され、0 を指定するとデフォルト値が使用されます。0 から 255 の範囲外の値を指定すると400が返されます。

  • Name
    sort_by
    Type
    string
    デフォルト -created_at
    Description

    並び順。

    利用可能な値:

    • -created_at: 新しい順
    • +created_at: 古い順

戻り値

パス内のステージに対応する、プロトタイプタスクオブジェクトまたはビルドタスクオブジェクトの配列。


Figure プロトタイプタスクオブジェクト

プロトタイプタスクは、写真からちびキャラ風のコンセプト画像を生成します。この画像を3Dモデルに変換するには、タスクのIDを input_task_id としてbuildエンドポイントに渡します。

プロパティ

Example Figure Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}
  • Name
    id
    Type
    string
    Description

    タスクID。形式には依存しないでください。

  • Name
    type
    Type
    string
    Description

    タスクの種類。常に creative-lab-figure-prototype です。

  • Name
    name
    Type
    string
    Description

    タスク作成時に送信した name。送信しなかった場合は "" です。

  • Name
    status
    Type
    string
    Description

    タスクのステータス。

    使用可能な値:

    • PENDING: キューで待機中
    • IN_PROGRESS: 結果を生成中
    • SUCCEEDED: 完了、結果あり
    • FAILED: 完了、理由は task_error に記載
    • CANCELED: 完了、結果なし
  • Name
    progress
    Type
    integer
    Description

    作業の進捗率(0 から 100 まで)。タスクが開始するまでは 0 で、成功すると 100 になります。

  • Name
    created_at
    Type
    timestamp
    Description

    タスクが作成された時刻(Unixミリ秒)。

  • Name
    started_at
    Type
    timestamp
    Description

    ワーカーがタスクを開始した時刻(Unixミリ秒)。開始するまでは null です。

  • Name
    finished_at
    Type
    timestamp
    Description

    タスクが最終ステータスに到達した時刻(Unixミリ秒)。到達するまでは null です。

  • Name
    expires_at
    Type
    timestamp
    Description

    タスクの結果が期限切れになる時刻(Unixミリ秒)。finished_at の3日後、またはタスクが完了するまでは created_at の3日後です。APIの結果を無期限に保持するEnterpriseアカウントの場合は、約100年後になります。アセット保持期間を参照してください。

  • Name
    preceding_tasks
    Type
    integer
    Description

    PENDING 中のタスクのキュー内での位置。1 は次に開始することを意味します。タスクがキューを離れると 0 になり、リスト結果では常に 0 です。

  • Name
    task_error
    Type
    object
    Description

    タスクが失敗した理由。status が FAILED でない限り null です。エラーを参照してください。

  • Name
    consumed_credits
    Type
    integer
    Description

    返金後にタスクに対して請求されたクレジット数。エラーを返すリクエストには課金されません。失敗したタスクはMeshyが返金するため 0 になります。キャンセルによる返金は、タスクが PENDING の間のみ行われます。Meshyが課金内容を読み取れない場合、getまたはstreamのレスポンスではこのフィールドが省略され、listリクエストは 500 を返します。その場合はリクエストを再試行してください。

  • Name
    image_urls
    Type
    array of strings
    Description

    コンセプト画像のダウンロードURL。タスクが成功すると配列に1つのURLが入り、それまでは空です。


フィギュアビルドタスクオブジェクト

ビルドタスクは、成功したプロトタイプタスクからテクスチャ付きの3Dフィギュアを生成します。その model_urls、thumbnail_url、texture_urls フィールドは、画像から3Dタスクオブジェクトと同じ形式です。

プロパティ

Example Figure Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}
  • Name
    id
    Type
    string
    Description

    タスクID。その形式に依存しないでください。

  • Name
    type
    Type
    string
    Description

    タスクタイプ。常に creative-lab-figure-build です。

  • Name
    name
    Type
    string
    Description

    タスク作成時に送信した name。送信しなかった場合は "" です。

  • Name
    status
    Type
    string
    Description

    タスクのステータス。

    使用可能な値:

    • PENDING: キューで待機中
    • IN_PROGRESS: 結果を生成中
    • SUCCEEDED: 最終状態、結果あり
    • FAILED: 最終状態、理由は task_error に記載
    • CANCELED: 最終状態、結果なし
  • Name
    progress
    Type
    integer
    Description

    作業完了の割合。0 から 100 まで。タスク開始までは 0、成功すると 100 になります。

  • Name
    created_at
    Type
    timestamp
    Description

    タスクが作成された時刻。Unixミリ秒単位。

  • Name
    started_at
    Type
    timestamp
    Description

    ワーカーがタスクを開始した時刻。Unixミリ秒単位。それまでは null です。

  • Name
    finished_at
    Type
    timestamp
    Description

    タスクが最終状態に達した時刻。Unixミリ秒単位。それまでは null です。

  • Name
    expires_at
    Type
    timestamp
    Description

    タスクの結果が期限切れになる時刻。Unixミリ秒単位。finished_at の3日後、またはタスクが完了するまでは created_at の3日後になります。APIの結果を無期限に保持するEnterpriseアカウントの場合は、約100年後になります。アセット保持期間を参照してください。

  • Name
    preceding_tasks
    Type
    integer
    Description

    PENDING 状態の間のキュー内でのタスクの位置。1 は次に開始することを意味します。タスクがキューを離れると 0 になり、リスト結果では常に 0 です。

  • Name
    task_error
    Type
    object
    Description

    タスクが失敗した理由。status が FAILED でない限り null です。エラーを参照してください。

  • Name
    consumed_credits
    Type
    integer
    Description

    返金後にタスクに課金されたクレジット数。エラーを返すリクエストには課金されません。失敗したタスクはMeshyが返金するため 0 になります。キャンセルによる返金は、タスクが PENDING の間のみ行われます。Meshyが課金額を読み取れない場合、getまたはstreamのレスポンスではこのフィールドが省略され、listリクエストは 500 を返します。その場合は、リクエストを再試行してください。

  • Name
    prompt
    Type
    string
    Description

    フィギュアビルドタスクでは常に "" です。

  • Name
    negative_prompt
    Type
    string
    Description

    prompt と同様、フィギュアビルドタスクでは常に "" です。

  • Name
    texture_prompt
    Type
    string
    Description

    prompt と同様、フィギュアビルドタスクでは常に "" です。

  • Name
    texture_image_url
    Type
    string
    Description

    prompt と同様、フィギュアビルドタスクでは常に "" です。

  • Name
    model_urls
    Type
    object
    Description

    テクスチャ付きGLBと、MTLファイルを伴うOBJファイルとしての、3Dモデルのダウンロード用URL。

    • Name
      glb
      Type
      string
      Description

      テクスチャ付きGLBファイルのダウンロード用URL。

    • Name
      obj
      Type
      string
      Description

      ジオメトリとUVを含むOBJファイルのダウンロード用URL。

    • Name
      mtl
      Type
      string
      Description

      obj に付随するMTLマテリアルファイルのダウンロード用URL。obj と、texture_urls[0].base_color 内のテクスチャとあわせて使用してください。

  • Name
    thumbnail_url
    Type
    string
    Description

    モデルのプレビュー画像のダウンロード用URL。

  • Name
    texture_urls
    Type
    array
    Description

    テクスチャマップ。ベースカラーマップを保持するオブジェクトを1つ含む配列です。

    • Name
      base_color
      Type
      string
      Description

      ベースカラーマップのダウンロード用URL。