クイックスタート

PixAI APIを起動して実行する

PixAI APIは、GraphQLエンドポイントを通じて簡単にアクセスできます。任意のGraphQLクライアントで API と通信できます。また、シンプルなHTTPエンドポイントとして利用することもできます。

もちろん、当社のSDKを使うのが最も簡単な方法です。

以下の言語のSDKを提供しています：

• JavaScript
• Golang

それぞれのリポジトリにある説明に従って始められます。

SDKでは、メインインターフェースを呼び出すための機能がほぼすべて提供されている。

クライアントの設定

ここでは、JavaScript言語を使用した例を示す：

クライアントにAPIキーを入れるだけで始めることができます。

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()
}

メモ

プラットフォームにアクセス権限を持つ場合、プロフィール編集ページでAPIトークンを作成できます。アクセストークンには多くの特権が許されるため、必ず安全な場所に保管してください！ GitHubやクライアント側のコードなど、一般にアクセス可能な場所でプライベートAPIキーを共有しないでください。

画像を生成し始めよう

クライアントを設定したら、画像を生成できます。 以下はtext-to-imageで画像を生成する例です。

JavaScript

注意

generateImageメソッドはWebSocketを使ってタスクの更新をリクエストしますので、 クライアントのコンストラクタに webSocketImpl パラメータを渡す必要があります。 WebSocketを使いたくない場合は、createGenerationTaskメソッドを使ってタスクを作成し、タスクのステータスをポーリングすることができます。

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
  }

ノート

modelIdの取得方法はモデルページを参照してください。

生成結果を確認

タスクオブジェクトには多くの情報が存在しますので、生成された画像を取得したいだけの場合、次のコードを参照してください。

JavaScript

const media = await client.getMediaFromTask(task)

Golang

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

画像をダウンロード

JavaScript SDKでは、メディアはパラメーターのbatchにより一枚以上の画像が含まれる可能性があります。画像が1枚しか生成されなかった場合。メディアは一つしかないと判断できます。

その後、メディアオブジェクトの内容を気にすることなく、内蔵メソッドを使用して画像を直接ダウンロードすることができます。

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
  }

次のステップ

上記は、APIを使い始める最も早い方法です。より詳しい情報や使い方を知りたい場合、当サイトのSDKのドキュメントやその他のドキュメントをご参照ください。