PixAI Platform
API v2 DocumentationModel

Get a model or LoRA

Reads one model by its model ID (the id of a search result).

GET
/generation-model/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In all requests that require authentication

In: header

Path Parameters

id*string

The model ID.

Response Body

application/json

application/json

curl -X GET "https://api.pixai.art/v2/generation-model/string"
{
  "id": "string",
  "title": "string",
  "type": "string",
  "category": "string",
  "loraBaseModelTypes": [
    "string"
  ],
  "permittedUse": "PERSONAL",
  "mediaId": "string",
  "latestAvailableVersionId": "string",
  "latestAvailableVersion": {
    "id": "string",
    "name": "string",
    "modelType": "string",
    "loraBaseModelType": "string",
    "extra": {
      "triggerWords": "string"
    }
  },
  "triggerWords": "string"
}
{
  "code": "string",
  "status": 0,
  "message": "string",
  "data": {},
  "defined": true
}

Register an uploaded image POST

Step 3 of uploading an image: turns the uploaded file into a media item. Call it after the `PUT` to `uploadUrl` has succeeded. The returned `id` is the media ID to pass to other endpoints.

Get a model version GET

Reads one model version by its version ID, the ID that generation endpoints take. Use it to look up a LoRA's trigger words and base model before generating.