GraphQL Schema
Query
| Field | Argument | Type | Description |
|---|---|---|---|
| media | Media | Mediaオブジェクトをidで取得する。 | |
| id | String! | ||
| task | Task | 生成タスクをidで取得する。 アクセス権限のあるタスクしか取得できません。 | |
| id | ID! | ||
Mutation
| Field | Argument | Type | Description |
|---|---|---|---|
| uploadMedia | UploadMediaRes! | メディアファイルをPixAIストレージにアップロード。ストレージをお持ちでないお客様には便利です。 詳細はストレージに関するドキュメントをお読みください。 | |
| input | UploadMediaInput! | ||
| createGenerationTask | Task | 生成タスクを作成。 | |
| parameters | JSONObject! | ||
| cancelGenerationTask | Task | 生成待ちの生成タスクをキャンセル。 reasonフィールドは必須項目ではありません。タスクの出力フィールドに保存される。 | |
| id | ID! | ||
| reason | String | ||
| rerunGenerationTask | Task | 失敗した生成タスクを再実行する。 | |
| id | ID! | ||
| deleteGenerationTask | Void | 生成タスクを削除する。 | |
| id | ID! | ||
Objects
Events
あらゆる可能な時間帯を含むワイドストラクチャー。
通常は一度に1つのフィールドしか返さない。
| Field | Argument | Type | Description |
|---|---|---|---|
| taskUpdated | Task | タスクオブジェクトが最新状態に更新。 | |
ImageUrl
| Field | Argument | Type | Description |
|---|---|---|---|
| variant | ImageVariant | ||
| url | String | ||
Media
Mediaタイプは画像と動画のための抽象型タイプです。
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String! | ||
| type | MediaType! | ||
| width | Int | ||
| height | Int | ||
| urls | [ImageUrl!] | このフィールドを使って、メディアの本当のURLを取得することができる。 | |
| imageType | String | ||
Subscription
クライアントがサーバーをリッスンするためのwebsocketサブスクリプション。
| Field | Argument | Type | Description |
|---|---|---|---|
| personalEvents | Events | このフィールドには、ユーザーアカウントに関するすべてのイベントが含まれてます。 | |
Task
生成タスクのオブジェクト。
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | The unique identifier of the task. | |
| userId | ID! | タスクの一意識別子。 | |
| parameters | JSONObject | タスクのパラメータ。 パラメータのフィールドを変更することが多いため、JSONオブジェクトを使用してGraphQLで表現します。 を使用します。 しかし、パラメータの詳細な構造を学ぶことができます。 詳しくドキュメントを参照してください。 | |
| outputs | JSONObject | タスクの出力結果。 パラメータ欄と似て推論サービスをより迅速に反復するために頻繁に変更されます。 詳細な構造はタスクの出力ドキュメントから知ることができる。 | |
| status | String | タスクのステータス。 この値はString（文字列）である。可能な値は以下の通り：
| |
| startedAt | Date | The actual time when the task started to execute. | |
| endAt | Date | The time when the task is completed. | |
| createdAt | Date! | The time when the task is created. | |
| updatedAt | Date! | The last modified time of the task object. | |
| retryCount | Int! | The retry count of the task. | |
UploadMediaRes
The response of uploading a media file.
| Field | Argument | Type | Description |
|---|---|---|---|
| uploadUrl | String | ||
| externalId | String | ||
| mediaId | String | ||
| media | Media | ||
Inputs
UploadMediaInput
The input for uploading a media file.
| Field | Type | Description | |
|---|---|---|---|
| type | MediaType! | ||
| externalId | String | ||
| imageType | String | The mime type of the file. e.g: image/jpeg, image/png. | |
| provider | MediaProvider | ||
Enums
ImageVariant
We provide some different variants of the image for different scenarios.
| Value | Description |
|---|---|
| PUBLIC | The original image. |
| THUMBNAIL | Can be used to obtain images of a certain size within a certain dimension. |
| STILL_THUMBNAIL | For gif images or videos. This will be a fixed image. |
MediaProvider
The storage provider for uploading media files.
Now we only support S3 for external users.
| Value | Description |
|---|---|
| S3 |
MediaType
The available media types.
Now we only support IMAGE for external users.
| Value | Description |
|---|---|
| IMAGE |
Scalars
Boolean
The Boolean scalar type represents true or false.
Date
Time information represented in ISO8601 format string.
ID
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Int
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
JSON
Any forms of valid JSON value.
JSONObject
Similar with JSON but only accept object type.
String
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Void
A scalar that represents an empty response.
You can don’t care about the response of a mutation.
It is usually be returned as null value.