API Documentation of Aitubo

Overview

This document describes how to use the code to achieve the same results as on the web. After document will only give relative address API, you need to cobble together to the main domain name: https://api.aitubo.ai.

For example, if you want to create a job, you need to call https://api.aitubo.ai/api/job/create

The document is divided into two sections, the first for examples and the second for specific API.

Examples

This section describes how to create a job and obtain a job. Our API for creating jobs provides three core functions: Text2Image, Image2Image, and ControlNet(ControlNet is a neural network structure to control diffusion models by adding extra conditions).

Regardless of which of the three features you use, first you have to get a list of the models we support, and then when you create the job, you need to pass in the id field of the model information

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

The result is something like this：

{
    "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"
}

Then, you will get a response like this:

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

You can check the status of task creation by polling. Each photo takes about 2 seconds to complete, so please control your query frequency. Finally, you will get like this:

{
  "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

To use Image2Image, you can call our Upload Image API to get an image’s OSS relative address, or you can give an image with an absolute address.

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
}'

You can check the status of task creation by polling just like the Text2Image.

3. ControlNet

Before using the ControlNet function, you must first call the /job/model/list API to obtain the corresponding ControlNet categories：

{
    "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"
            },
            ...
    }
}

Then call /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"
}'

You can also pass modelId field(Make sure that the model supports 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"
}'

APIS

1. Upload Image

Basic Info

Path： /api/job/upload-image

Method： POST

Request Params

Headers

Body

Response Data

2. Create Job

Basic Info

Path： /api/job/create

Method： POST

Request Params

Headers

Body

Response Data

3. Get Job

Basic Info

Path： /api/job/get

Method： GET

Request Params

Query

Response Data

4. List ControlNet Model

Basic Info

Path： /api/job/models

Method： GET

Response Data

5. List Histroy Job

Basic Info

Path： /api/job/list

Method： GET

Request Params

Headers

Query

Response Data

6. List Model

Basic Info

Path： /api/model/list

Method： GET

Request Params

Headers

Query

Response Data

7. Super Resolution

Basic Info

Path： /api/job/upscale

Method： POST

Request Params

Headers

Body

Response Data

8. Image Segmentation

Basic Info

Path： /api/art/segment

Method： POST

Request Params

Headers

Body

Response Data

9. GetUserInfo

Basic Info

Path： /api/user/profile

Method： GET

Request Params

Headers

Response Data

10. Headshot

10.1 List Templates

Basic Info

Path： api/transform/list

Method： GET

Response Data

10.2 Create Headshot

Basic Info

Path： api/transform/create-headshot

Method： POST

Headers

Body

Response Data

Commercial Service-toB/API

[email protected]