API ドキュメント
MiqX APIの完全なドキュメント
目次
MiqX APIは、名言風のコラ画像やスマブラ参戦画像を生成するRust製の高性能APIです。豊富なフォント、細かなカスタマイズ、絶妙な改行処理、圧倒的な生成スピードを特徴としています。
ベースURL
https://api.miqx.jpBearer Token認証を使用します
HTTP Header
Authorization: Bearer YOUR_API_KEYPOST
/v1/make認証必須指定したアイコンでコラ画像を生成します
パラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
text | string | 必須 | 発言内容 |
name | string | 必須 | 発言者の名前 |
id | string | 必須 | メッセージの固有識別子（英数字のみ） |
mid | string | 必須 | 発言者の固有識別子 |
param | string | 任意 | カスタムパラメータ |
img | binary | 任意 | アイコン画像（PNG/JPG、未指定時はデフォルトアイコン） |
hideLogo | boolean | 任意 | Miq-Xロゴを非表示にする（Basic以上のプランで利用可能） |
upload | boolean | 任意 | 画像をURL化して返す（Starter以上のプランで利用可能） |
サンプルコード
curl -X POST https://api.miqx.jp/v1/make \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "text=Hello World!!" \
-F "name=Steve Jobs" \
-F "id=user0001" \
-F "mid=94f7d0e8-98b3-4f79-971f-884e335f337a" \
-F "param=make" \
-F "img=@icon.png" \
-F "hideLogo=true" \
-F "upload=true"レスポンス
成功時 (200 OK)
JSON
{
"status": "success",
"message": "Image generated successfully",
"data": {
"image": "base64_encoded_png_image"
}
}成功時 ※Uploadオプション使用時 (200 OK)
JSON
{
"status": "success",
"message": "Image generated successfully",
"data": {
"image": "base64_encoded_png_image",
"url": "https://.../your_uploaded_image.png"
}
}エラー時 (400/500)
JSON
{
"status": "error",
"message": "Descriptive error message in English",
"error_code": "VALIDATION_ERROR"
}| HTTPステータス | エラーメッセージ | エラーコード | 説明 |
|---|---|---|---|
| 400 | Text is required when stamp is not provided | VALIDATION_ERROR | テキストが空でスタンプも提供されていない |
| 400 | Name is required | VALIDATION_ERROR | 名前が空または無効 |
| 400 | Mid is required | VALIDATION_ERROR | MIDが空または無効 |
| 400 | Id is required | VALIDATION_ERROR | IDが空または無効 |
| 400 | Id must contain only alphanumeric characters | VALIDATION_ERROR | IDに英数字以外が含まれている |
| 400 | Invalid metadata format | VALIDATION_ERROR | メタデータの形式が無効 |
| 400 | Image is required | VALIDATION_ERROR | 画像が見つからない |
| 400 | Unsupported Content-Type | UNSUPPORTED_CONTENT_TYPE | サポートされていないContent-Type |
| 400 | Failed to parse multipart data | MULTIPART_ERROR | マルチパートデータの解析に失敗 |
| 400 | Failed to read request body | BODY_READ_ERROR | リクエストボディの読み取りに失敗 |
| 400 | Invalid UTF-8 in request body | ENCODING_ERROR | リクエストボディのエンコーディングエラー |
| 401 | Invalid API key | - | APIキーが無効 |
| 500 | Failed to generate image | GENERATION_ERROR | 画像生成に失敗 |
| 500 | An error occurred during image generation | GENERATION_ERROR | 画像生成中にエラーが発生 |
| 500 | A panic occurred during image generation | PANIC_ERROR | 画像生成中にパニックが発生 |
禁止事項
- •APIキーを他者に配布すること
- •パラメータ（name, mid, id）の改変
- •上記の改変による偽のコラ画像生成（開発段階の動作テストを除く）
- •APIへの不正リクエストの送信
- •APIサーバーへの悪意ある攻撃
- •APIサーバーのIPアドレスの公開
- •その他、常識的に考えて迷惑になる行為
推奨事項
- •idはメッセージごとに一意の値を設定
- •midはユーザーIDなどの一意識別子を設定
- •全てのパラメータは文字列として送信