メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt

Use this file to discover all available pages before exploring further.

Artistic QR Tasks API の主な機能は、Artistic QR Generation API によって生成されたタスクIDを入力することで、そのタスクの実行状況を照会することです。 この文書では、Artistic QR Tasks API の接続説明を詳しく紹介し、簡単に統合し、この API の強力な機能を十分に活用できるようにします。Artistic QR Tasks API を使用することで、Artistic QR Generation API のタスク実行状況を簡単に照会できます。

​
申請プロセス

Artistic QR Tasks API を使用するには、まず申請ページ Artistic QR Generation API にアクセスして、該当するサービスを申請し、その後、Artistic QR Generation API のタスクIDをコピーします。以下の図のように：

最後に、Artistic QR Tasks API ページ Artistic QR Tasks API にアクセスして、該当するサービスを申請し、ページに入ったら「Acquire」ボタンをクリックします。以下の図のように： 申請ページ まだログインまたは登録していない場合は、自動的にログインページにリダイレクトされ、登録とログインを促されます。ログインまたは登録後は、自動的に現在のページに戻ります。 初回申請時には無料のクレジットが付与され、この API を無料で使用できます。

​
リクエスト例

Artistic QR Tasks API は、Artistic QR Generation API の結果を照会するために使用できます。Artistic QR Generation API の使用方法については、文書 Artistic QR Generation API を参照してください。 Artistic QR Generation API サービスから返されたタスクIDの一例を用いて、この API の使用方法を示します。タスクID：e2c65b20-a970-431e-99c1-76721e799df8 があると仮定し、次にタスクIDを渡す方法を示します。

​
タスク例の画像

​
リクエストヘッダーとリクエストボディの設定

Request Headers には以下が含まれます：
  • accept：JSON形式のレスポンス結果を受け取ることを指定し、ここには application/json を記入します。
  • authorization：APIを呼び出すためのキーで、申請後に直接ドロップダウンから選択できます。
Request Body には以下が含まれます：
  • id：アップロードされたタスクID。
  • action：タスクの操作方法。
以下の図のように設定します：

​
コード例

ページの右側には、さまざまな言語のコードが自動生成されていることがわかります。以下の図のように：

一部のコード例は以下の通りです：

​
CURL

curl -X POST 'https://api.xhuoapi.ai/v1/qrart/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "id": "e2c65b20-a970-431e-99c1-76721e799df8",
  "action": "retrieve"
}'

​
Python

import requests

url = "https://api.xhuoapi.ai/v1/qrart/tasks"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "id": "e2c65b20-a970-431e-99c1-76721e799df8",
    "action": "retrieve"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​
レスポンス例

リクエストが成功すると、API はこのQRコードタスクの詳細情報を返します。例えば： 
{
  "_id": "668cb62c550a4144a582e372",
  "id": "e2c65b20-a970-431e-99c1-76721e799df8",
  "application_id": "3d25be99-4676-44d3-90bb-23086bc25300",
  "created_at": 1720497708.318,
  "credential_id": "6e80fca1-9a49-4507-ae8e-601dbd0ab3ca",
  "request": {
    "aspect_ratio": "1:1",
    "callback_url": null,
    "content": "https://api.xhuoapi.ai",
    "content_image_url": null,
    "ecl": "H",
    "image_origin": null,
    "marker_shape": "square",
    "negative_prompt": null,
    "padding_level": 5,
    "padding_noise": 0,
    "pattern": "custom",
    "pixel_style": "square",
    "position": "center",
    "preset": "",
    "prompt": "mexican tacos",
    "qrw": 2,
    "ratio": null,
    "rotate": 0,
    "seed": null,
    "steps": 20,
    "sub_marker": "square",
    "timeout": null,
    "trace_id": "a99ecc24-eda0-45c6-bb5f-98060c30b490",
    "type": "link"
  },
  "response": {
    "image_url": "https://platform.cdn.xhuoapi.ai/qrart/e2c65b20-a970-431e-99c1-76721e799df8.png",
    "image_width": 768,
    "image_height": 768,
    "seed": 5324369603686616,
    "success": true
  }
}
返された結果には複数のフィールドがあり、request フィールドはタスクを開始したときの request body であり、response フィールドはタスク完了後に返される response body で、その結果は Artistic QR Generation API のリクエストと返却と一致します。フィールドの説明は以下の通りです。
  • id：このQRコードタスクを生成するためのIDで、今回のQRコード生成タスクを一意に識別します。
  • request：QRコードタスク内のリクエスト情報を照会します。
  • response：QRコードタスク内の返却情報を照会します。

​
バッチ照会操作

これは複数のQRコードタスクIDに対してQRコードタスクの詳細を照会するためのもので、上記とは異なり、action を retrieve_batch に設定する必要があります。 Request Body には以下が含まれます：
  • ids：アップロードされたタスクIDの配列。
  • action：タスクの操作方法。
以下の図のように設定します：

​
コード例

ページの右側には、さまざまな言語のコードが自動生成されていることがわかります。以下の図のように：

一部のコード例は以下の通りです：

​
レスポンス例

リクエストが成功すると、API は今回のすべてのバッチQRコードタスクの具体的な詳細情報を返します。例えば： 
{
  "items": [
    {
      "_id": "668cb90e550a4144a5834557",
      "id": "8c89e97b-6a79-4406-b2ce-e00f92540b4e",
      "application_id": "3d25be99-4676-44d3-90bb-23086bc25300",
      "created_at": 1720498446.039,
      "credential_id": "b7f9aaa1-43d8-471f-a826-cd0f4733fec5",
      "request": {
        "aspect_ratio": "1:1",
        "callback_url": null,
        "content": "https://huyinfu.space",
        "content_image_url": null,
        "ecl": "H",
        "image_origin": null,
        "marker_shape": "square",
        "negative_prompt": null,
        "padding_level": 5,
        "padding_noise": 0,
        "pattern": "custom",
        "pixel_style": "square",
        "position": "center",
        "preset": "",
        "prompt": "メキシコのタコス",
        "qrw": 2,
        "ratio": null,
        "rotate": 0,
        "seed": null,
        "steps": 20,
        "sub_marker": "square",
        "timeout": null,
        "trace_id": "44d33486-0527-451f-afc2-df11aab7e049",
        "type": "link"
      },
      "response": {
        "image_url": "https://platform.cdn.xhuoapi.ai/qrart/8c89e97b-6a79-4406-b2ce-e00f92540b4e.png",
        "image_width": 768,
        "image_height": 768,
        "seed": 2701847236953402,
        "success": true
      }
    },
    {
      "_id": "668cb62c550a4144a582e372",
      "id": "e2c65b20-a970-431e-99c1-76721e799df8",
      "application_id": "3d25be99-4676-44d3-90bb-23086bc25300",
      "created_at": 1720497708.318,
      "credential_id": "6e80fca1-9a49-4507-ae8e-601dbd0ab3ca",
      "request": {
        "aspect_ratio": "1:1",
        "callback_url": null,
        "content": "https://api.xhuoapi.ai",
        "content_image_url": null,
        "ecl": "H",
        "image_origin": null,
        "marker_shape": "square",
        "negative_prompt": null,
        "padding_level": 5,
        "padding_noise": 0,
        "pattern": "custom",
        "pixel_style": "square",
        "position": "center",
        "preset": "",
        "prompt": "メキシコのタコス",
        "qrw": 2,
        "ratio": null,
        "rotate": 0,
        "seed": null,
        "steps": 20,
        "sub_marker": "square",
        "timeout": null,
        "trace_id": "a99ecc24-eda0-45c6-bb5f-98060c30b490",
        "type": "link"
      },
      "response": {
        "image_url": "https://platform.cdn.xhuoapi.ai/qrart/e2c65b20-a970-431e-99c1-76721e799df8.png",
        "image_width": 768,
        "image_height": 768,
        "seed": 5324369603686616,
        "success": true
      }
    }
  ],
  "count": 2
}

​
CURL

curl -X POST 'https://api.xhuoapi.ai/v1/qrart/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "ids": ["8c89e97b-6a79-4406-b2ce-e00f92540b4e","e2c65b20-a970-431e-99c1-76721e799df8"],
  "action": "retrieve_batch"
}'

​
Python

import requests

url = "https://api.xhuoapi.ai/v1/qrart/tasks"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "ids": ["8c89e97b-6a79-4406-b2ce-e00f92540b4e","e2c65b20-a970-431e-99c1-76721e799df8"],
    "action": "retrieve_batch"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​
エラー処理

APIを呼び出す際にエラーが発生した場合、APIは対応するエラーコードと情報を返します。例えば：
  • 400 token_mismatched：不正なリクエスト、パラメータが不足しているか無効である可能性があります。
  • 400 api_not_implemented：不正なリクエスト、パラメータが不足しているか無効である可能性があります。
  • 401 invalid_token：認証されていない、無効または不足している認証トークン。
  • 429 too_many_requests：リクエストが多すぎます、レート制限を超えました。
  • 500 api_error：内部サーバーエラー、サーバーで何かがうまくいきませんでした。

​
エラー応答の例

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "取得に失敗しました"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
結論

本ドキュメントを通じて、Artistic QR Tasks APIを使用して単一またはバッチのQRコードタスクのすべての具体的な詳細情報を照会する方法を理解しました。このドキュメントがAPIの接続と使用に役立つことを願っています。ご不明な点がございましたら、いつでも技術サポートチームにお問い合わせください。