レスポンスの作成

リクエストパラメータ

フィールド型必須説明

model: string必須

モデルID。安定版モデルIDの使用を推奨します。固定バージョンを再現する必要がある場合は、スナップショットモデルIDを指定できます。

input: array必須

入力メッセージの配列。現在はrole=userのメッセージをちょうど1件含める必要があります。

input[].role: string必須

現在はuserで固定です。

input[].content: array必須

コンテンツの配列。空でないinput_textを少なくとも1つ含み、さらに1～5個のinput_imageまたは1個のinput_videoを含める必要があります。画像と動画を混在させて入力することはできません。

input[].content[].type: string必須

コンテンツの種類。

input_text.text: string必須

画像または動画の理解に関する指示。空でない文字列である必要があります。

input_image.image_url: string条件付き必須

サーバーからアクセス可能な画像URL。同じコンテンツ項目のfile_idといずれか一方を指定します。画像1枚あたり最大30 MBで、PNG、JPG、JPEG、WebP、BMP、GIF、TIFFに対応しています。

input_image.file_id: string条件付き必須

アップロード済み画像のファイルID。同じコンテンツ項目のimage_urlといずれか一方を指定します。画像1枚あたり最大30 MBで、PNG、JPG、JPEG、WebP、BMP、GIF、TIFFに対応しています。

input_video.video_url: string条件付き必須

サーバーからアクセス可能な動画URL。同じコンテンツ項目のfile_idといずれか一方を指定します。動画1本あたり最大200 MBで、現在は動画の長さに制限はありません。MP4、M4V、AVI、MOV、WebM、MKVに対応しています。

input_video.file_id: string条件付き必須

アップロード済み動画のファイルID。同じコンテンツ項目のvideo_urlといずれか一方を指定します。動画1本あたり最大200 MBで、現在は動画の長さに制限はありません。MP4、M4V、AVI、MOV、WebM、MKVに対応しています。

max_output_tokens: integer任意

最大出力トークン数。範囲は1～8192です。

戻り値

APIはResponses APIオブジェクトを返します。モデルが生成したテキストはoutput[].content[].textにあります。出力が完全かどうかはstatusで判断します。

フィールド型説明

status: string

レスポンスの状態。現在はcompletedまたはincompleteです。

incomplete_details.reason: string | null

出力が不完全な理由。出力上限に達した場合はmax_output_tokensです。

output: array

出力項目のリスト。

output[].content: array

出力コンテンツのリスト。

output[].content[].type: string

現在、テキスト結果ではoutput_textで固定です。

output[].content[].text: string

モデルが生成したテキスト結果。

usage.input_tokens: integer

今回のリクエストで使用した入力トークン数。

usage.output_tokens: integer

今回のリクエストで生成した出力トークン数。

usage.total_tokens: integer

入力トークンと出力トークンの合計数。

レスポンスにはID、オブジェクトの種類、時刻、モデルなどの共通メタデータも含まれます。完全な構造は右側のレスポンス例を参照してください。クライアントは使用しない追加フィールドを無視してください。usageは今回のリクエストのトークン使用量のみを表します。

エラーコード

HTTPerror.code発生条件と対処方法

400: 5件のerror.code

入力内容の欠落、メディア数の上限超過、画像と動画の混在、またはメディアのソース / 形式の不正。

次のステップ

ファイルのアップロード

画像または動画をアップロードし、再利用可能なfile_idを取得します。

リクエスト制限

公開APIの安定した入力制限を確認します。

リクエスト例

curl -X POST "https://api.mosi.cn/v1/responses" \
  -H "Authorization: Bearer $MOSS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "moss-vl-1.0",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "画像の主な内容を説明してください。"
        },
        {
          "type": "input_image",
          "image_url": "https://example.com/image.jpg"
        }
      ]
    }
  ],
  "max_output_tokens": 1024
}'

import os
import requests

response = requests.post(
        "https://api.mosi.cn/v1/responses",
        headers={
        "Authorization": f"Bearer {os.environ['MOSS_API_KEY']}",
        "Content-Type": "application/json",
        },
        json={
            "model": "moss-vl-1.0",
            "input": [
                {
                    "role": "user",
                    "content": [
                        {
                            "type": "input_text",
                            "text": "画像の主な内容を説明してください。",
                        },
                        {
                            "type": "input_image",
                            "image_url": "https://example.com/image.jpg",
                        },
                    ],
                },
            ],
            "max_output_tokens": 1024,
        },
)

response.raise_for_status()
print(response.json())

const response = await fetch("https://api.mosi.cn/v1/responses", {
  method: "POST",
  headers: {
    "Authorization": "Bearer " + process.env.MOSS_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "model": "moss-vl-1.0",
    "input": [
      {
        "role": "user",
        "content": [
          {
            "type": "input_text",
            "text": "画像の主な内容を説明してください。"
          },
          {
            "type": "input_image",
            "image_url": "https://example.com/image.jpg"
          }
        ]
      }
    ],
    "max_output_tokens": 1024
  }),
})

if (!response.ok) throw new Error(`HTTP ${response.status}`)
console.log(await response.json())

curl -X POST "https://api.mosi.cn/v1/responses" \
  -H "Authorization: Bearer $MOSS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "moss-vl-1.0",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "2枚の画像の共通点と相違点を比較してください。"
        },
        {
          "type": "input_image",
          "file_id": "<image_file_id_1>"
        },
        {
          "type": "input_image",
          "file_id": "<image_file_id_2>"
        }
      ]
    }
  ],
  "max_output_tokens": 1024
}'

import os
import requests

response = requests.post(
        "https://api.mosi.cn/v1/responses",
        headers={
        "Authorization": f"Bearer {os.environ['MOSS_API_KEY']}",
        "Content-Type": "application/json",
        },
        json={
            "model": "moss-vl-1.0",
            "input": [
                {
                    "role": "user",
                    "content": [
                        {
                            "type": "input_text",
                            "text": "2枚の画像の共通点と相違点を比較してください。",
                        },
                        {
                            "type": "input_image",
                            "file_id": "<image_file_id_1>",
                        },
                        {
                            "type": "input_image",
                            "file_id": "<image_file_id_2>",
                        },
                    ],
                },
            ],
            "max_output_tokens": 1024,
        },
)

response.raise_for_status()
print(response.json())

const response = await fetch("https://api.mosi.cn/v1/responses", {
  method: "POST",
  headers: {
    "Authorization": "Bearer " + process.env.MOSS_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "model": "moss-vl-1.0",
    "input": [
      {
        "role": "user",
        "content": [
          {
            "type": "input_text",
            "text": "2枚の画像の共通点と相違点を比較してください。"
          },
          {
            "type": "input_image",
            "file_id": "<image_file_id_1>"
          },
          {
            "type": "input_image",
            "file_id": "<image_file_id_2>"
          }
        ]
      }
    ],
    "max_output_tokens": 1024
  }),
})

if (!response.ok) throw new Error(`HTTP ${response.status}`)
console.log(await response.json())

curl -X POST "https://api.mosi.cn/v1/responses" \
  -H "Authorization: Bearer $MOSS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "moss-vl-1.0",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "動画の出来事を時系列で要約してください。"
        },
        {
          "type": "input_video",
          "video_url": "https://example.com/video.mp4"
        }
      ]
    }
  ],
  "max_output_tokens": 1024
}'

import os
import requests

response = requests.post(
        "https://api.mosi.cn/v1/responses",
        headers={
        "Authorization": f"Bearer {os.environ['MOSS_API_KEY']}",
        "Content-Type": "application/json",
        },
        json={
            "model": "moss-vl-1.0",
            "input": [
                {
                    "role": "user",
                    "content": [
                        {
                            "type": "input_text",
                            "text": "動画の出来事を時系列で要約してください。",
                        },
                        {
                            "type": "input_video",
                            "video_url": "https://example.com/video.mp4",
                        },
                    ],
                },
            ],
            "max_output_tokens": 1024,
        },
)

response.raise_for_status()
print(response.json())

const response = await fetch("https://api.mosi.cn/v1/responses", {
  method: "POST",
  headers: {
    "Authorization": "Bearer " + process.env.MOSS_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "model": "moss-vl-1.0",
    "input": [
      {
        "role": "user",
        "content": [
          {
            "type": "input_text",
            "text": "動画の出来事を時系列で要約してください。"
          },
          {
            "type": "input_video",
            "video_url": "https://example.com/video.mp4"
          }
        ]
      }
    ],
    "max_output_tokens": 1024
  }),
})

if (!response.ok) throw new Error(`HTTP ${response.status}`)
console.log(await response.json())

レスポンス例

{
  "id": "resp_task_abc123",
  "object": "response",
  "created_at": 1710000000,
  "status": "completed",
  "completed_at": 1710000001,
  "error": null,
  "incomplete_details": null,
  "model": "moss-vl-1.0",
  "output": [
    {
      "id": "msg_task_abc123",
      "type": "message",
      "status": "completed",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "画像には4つのナッツがあります。"
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 8743,
    "output_tokens": 94,
    "total_tokens": 8837
  }
}