Aitubo 的 API 文件

總覽

此文件描述如何使用程式碼來達到與網頁相同的結果。 之後的文件只會提供相對位址 API，您需要將其拼湊到主網域名稱： https://api.aitubo.ai.

例如，如果您想建立一個工作，您需要呼叫 https://api.aitubo.ai/api/job/create

該文件分為兩個部分，第一部分為範例，第二部分為特定 API。

範例

本節描述如何建立工作並取得工作。 我們用於建立工作的 API 提供了三個核心功能： Text2Image, Image2Image, and ControlNet（ControlNet 是一個神經網路結構，透過新增額外條件來控制擴散模型）。

無論您使用哪三個功能，首先您必須取得我們支援的模型清單，然後在您建立工作時，您需要傳入 id 模型資訊的欄位

curl --request GET \
  --url 'https://api.aitubo.ai/api/model/list?type=platform' \
  --header 'Authorization: Bearer ced695cfd83811eda5e286850d1dc848'

結果類似這樣：

{
    "code": 0,
    "data": {
        "domain": "https://file.aitubo.ai/",
        "total": 10,
        "models": [
            {
                "id": "6426f9c60ca4651b98b91a6d",
                "name": "ConceptCanvas",
                "username": "Aitubo",
                "desc": "A model that creates concept scenes with a European thick paint or CG style.",
                "cover": "assets/model/6426f9c60ca4651b98b91a6d/cover.jpg",
                "isFavourite": false,
                "controlNet": false
            },
            {
                "id": "642b977d2f2842537c09fe41",
                "name": "DreamShaper",
                "username": "Aitubo",
                "desc": "A model that can generate multiple styles of scenes, characters, and game assets.",
                "cover": "assets/model/642b977d2f2842537c09fe41/cover.jpg",
                "isFavourite": false,
                "controlNet": true
            },
            ...
        ]
    }
}

1. Text2Image

curl --request POST \
  --url https://api.aitubo.ai/api/job/create \
  --header 'Authorization: Bearer ced695cfd83811eda5e286850d1dc848' \
  --header 'content-type: application/json' \
  --data '{
    "prompt": "A cat sleeps on the plane",
    "modelId": "642b977d2f2842537c09fe41"
}

然後，您將收到類似這樣的回應：

{
  "code": 0,
  "data": {
    "consumedCredit": 40,
    "credit": 120,
    "id": "64351e4d567bcd86773dc841"
  }
}

您可以透過輪詢來檢查任務建立的狀態。 每張照片大約需要 2 秒才能完成，因此請控制您的查詢頻率。 最後，您會得到這樣：

{
  "code": 0,
  "data": {
    "id": "64351e4d567bcd86773dc841",
    "args": {
      "prompt": "A cat sleeps on the plane",
      "negativePrompt": "lowres, bad anatomy, cropped, worst quality, low quality",
      "strength": 0.8,
      "width": 512,
      "height": 512,
      "count": 4,
      "steps": 30,
      "modelId": "642b977d2f2842537c09fe41"
    },
    "result": {
      "info": "Warning: some images may contain NSFW content",
      "data": {
        "images": [
          "images/art/640076a4661aa1c0f81ba2d7/cgqhsljj5mf00080001g.png",
          "images/art/640076a4661aa1c0f81ba2d7/cgqhsljj5mf000800020.png",
          "images/art/640076a4661aa1c0f81ba2d7/cgqhsljj5mf00080002g.png",
          "images/art/640076a4661aa1c0f81ba2d7/cgqhsljj5mf000800030.png"
        ],
        "artIds": [
          "64351e56567bcd86773dc842",
          "64351e56567bcd86773dc843",
          "64351e56567bcd86773dc844",
          "64351e56567bcd86773dc845"
        ],
        "domain": "https://file.aitubo.ai/"
      }
    },
    "status": 2,
    "createAt": "2023-04-11T08:46:05.55Z"
  }
}

2. Image2Image

若要使用 Image2Image，您可以呼叫我們的 上傳圖片 API 以取得圖片的 OSS 相對位址，或者您可以提供具有絕對位址的圖片。

curl --request POST \
  --url https://api.aitubo.ai/api/job/create \
  --header 'Authorization: Bearer ced695cfd83811eda5e286850d1dc848' \
  --header 'content-type: application/json' \
  --data '{
    "imagePath": "images/tmp/cgqi1jntuq4000800040.png",
    "modelId": "642b977d2f2842537c09fe41",
    "prompt": "scene",
    "guidanceScale": 0.7
}'

您可以像 Text2Image 一樣透過輪詢來檢查任務建立的狀態。

3. ControlNet

在使用 ControlNet 功能之前，您必須先呼叫 /job/model/list API 以取得相應的 ControlNet 類別：

{
    "code": 0,
    "data": {
        "domain": "https://file.aitubo.ai/",
        "models": [
            {
                "id": "canny",
                "name": "canny",
                "icon": "assets/template/control_canny.jpg"
            },
            {
                "id": "scribble",
                "name": "scribble",
                "icon": "assets/template/control_scribble.jpg"
            },
            ...
    }
}

然後呼叫 /job/create API：

curl --request POST \
  --url https://api.aitubo.ai/api/job/create \
  --header 'Authorization: Bearer ced695cfd83811eda5e286850d1dc848' \
  --header 'content-type: application/json' \
  --data '{    "imagePath": "https://ichef.bbci.co.uk/news/976/cpsprodpb/17638/production/_124800859_gettyimages-817514614.jpg.webp",
    "controlModel": "canny",
    "prompt": "a little dog"
}'

您也可以傳遞 modelId 欄位(確保模型支援 ControlNet):

curl --request POST \
  --url https://api.aitubo.ai/api/job/create \
  --header 'Authorization: Bearer ced695cfd83811eda5e286850d1dc848' \
  --header 'content-type: application/json' \
  --data '{
    "imagePath": "https://ichef.bbci.co.uk/news/976/cpsprodpb/17638/production/_124800859_gettyimages-817514614.jpg.webp",
    "controlModel": "canny",
    "prompt": "a little dog",
    "modelId": "642b977d2f2842537c09fe41"
}'

API

1. 上傳圖片

基本資訊

路徑： /api/job/upload-image

方法： POST

請求參數

標頭

主體

回應資料

2. 建立工作

基本資訊

路徑： /api/job/create

方法： POST

請求參數

標頭

主體

回應資料

3. 取得工作

基本資訊

路徑： /api/job/get

方法： GET

請求參數

查詢

Response Data

4. 列出 ControlNet 模型

基本資訊

路徑： /api/job/models

方法： GET

回應資料

5. 列出歷史工作

基本資訊

路徑： /api/job/list

方法： GET

請求參數

標頭

Query

回應資料

6. 列出模型

基本資訊

路徑： /api/model/list

方法： GET

請求參數

標頭

查詢

回應資料

7. 超解析度

基本資訊

路徑： /api/job/upscale

方法： POST

請求參數

標頭

主體

回應資料

8. 影像分割

基本資訊

路徑： /api/art/segment

方法： POST

請求參數

標頭

主體

回應資料

9. 取得使用者資訊

基本資訊

路徑： /api/user/profile

方法： GET

請求參數

標頭

回應資料

10. 建立頭像

10.1 列出範本

基本資訊

路徑： api/transform/list

方法： GET

回應資料

10.2 建立頭像

基本資訊

路徑： api/transform/create-headshot

方法： POST

標頭

主體

回應資料

商業服務-toB/API

[email protected]