Quickstart

Get up and running with the PixAI API

The PixAI API are most easily accessed via the GraphQL endpoint. You can use any GraphQL client to interact with the API. Or even use it as a simple HTTP endpoint.

But the most easily way to get started is to use our SDK.

We provide SDKs for the following languages:

• JavaScript
• Golang

You can follow the instructions in the respective repositories to get started.

Most SDKs provide relatively complete encapsulation for calling our main interfaces.

Setting up the client

Here is an example using the JavaScript language:

You just need to pass your API key to the client. And this all you need to get started.

JavaScript

import PixAIClient from 'pixai-client-js'

const client = new PixAIClient({
  apiKey: 'YOUR_API_KEY',
})

Golang

package main

import (
  pixai_client "github.com/pixai-art/pixai-client-go"
)

func main() {
  client := pixai_client.NewPixAIClient().
    SetApiKey("YOUR_API_KEY").
    Init()
}

Note

You can create an access token on your profile edit page if you have access to the platform. Access tokens carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Start to generate images

After setting up the client, you can start to generate images. Here is an example of generating an image with text-to-image.

JavaScript

Note

The generateImage method will use WebSocket to get the task updates. You need to pass the webSocketImpl parameter to the client constructor. If you don’t want to use WebSocket, you can use the createGenerationTask method to create a task and poll the task status.

const task = await client.generateImage(
  {
    prompts: '1girl',
    modelId: '1648918127446573124',
    width: 512,
    height: 512,
  },
)
console.log('Task completed: ', task)

Golang

  params := pixai_client.JSONObject{
    "width":   512,
    "height":  512,
    "prompts": "miku",
    "modelId": "1648918127446573124",
  }

  ctx := context.Background()

  task, err := client.GenerateImage(ctx, params, func(task *pixai_client.TaskBase) {
    fmt.Printf("Task Updated: %+v\n", task)
  })
  if err != nil {
    fmt.Printf("Error: %+v\n", err)
    return
  }

Note

You can learn how to get the modelId from the Models page.

Get the result

In the task object, there will be a lot of information. If you just want to get the generated image, you can refer to the following code.

JavaScript

const media = await client.getMediaFromTask(task)

Golang

  media, err := client.GetMediaFromTask(ctx, task)
  if err != nil {
    fmt.Printf("Error: %+v\n", err)
    return
  }

Download the image

In the JavaScript SDK. The obtained media may contain one or more images, depending on the batch in the parameters. If you only generated one image. You can assert that there is only one media.

Afterwards, you can use the built-in method to directly download the image without concerning about the content of the media object.

JavaScript

assert(media && !Array.isArray(media))

const buffer = await client.downloadMedia(media)

await fs.writeFile('output.png', Buffer.from(buffer))

Golang

  file, mimeType, err := client.DownloadMedia(ctx, media[0])
  if err != nil {
    fmt.Printf("Error: %+v\n", err)
    return
  }
  ext, _ := mime.ExtensionsByType(mimeType)
  err = os.WriteFile("output"+ext[0], file, 0644)
  if err != nil {
    fmt.Printf("Error: %+v\n", err)
    return
  }

Next steps

The above is the fastest way to start using the API. If you want to know more information or more usage, you can refer to the documentation of our SDK and other documents on this site.