PixAI Platform
API v2 DocumentationModel

Search models and LoRAs

Searches the PixAI Model Market. Use it to find a base model for modelVersionId, or LoRAs for loras of POST /v2/image/create.

To use a result, pass its latestAvailableVersionId, not its id: generation endpoints take version IDs. A LoRA's default trigger words are in latestAvailableVersion.extra.triggerWords.

To find LoRAs that work with a base model, send usageType=LORA and the base model's type in loraBaseModelTypes (the type of a model item, e.g. SDXL_MODEL).

Results depend on who is asking: send your API key to get the same content rating as your account. Anonymous requests get stricter filtering.

GET
/generation-model/search

Authorization

bearerAuth
AuthorizationBearer <token>

In all requests that require authentication

In: header

Query Parameters

usageType*||

MODEL for base models, LORA for LoRAs, ALL for both.

Value in"ALL" | "MODEL" | "LORA"
keyword?string

Free-text query. Results rank by relevance and popularity; without a keyword, by popularity.

Length1 <= length <= 256
loraBaseModelTypes?string

With usageType=LORA: comma-separated base model types the LoRA must work with, e.g. SDXL_MODEL.

baseModelIds?string

With usageType=LORA: comma-separated base model IDs the LoRA must work with.

source?string

With usageType=LORA: PIXAI for LoRAs trained on PixAI, EXTERNAL for imported ones.

Default"ANY"
Value in"ANY" | "PIXAI" | "EXTERNAL"
baseModelType?string

With usageType=MODEL: comma-separated model types, e.g. SDXL_MODEL,MMDIT26B_MODEL.

permittedUse?string

Only models whose license allows this use.

Value in"COMMERCIAL" | "PERSONAL"
postedWithin?string
Value in"today" | "this-week" | "this-month"
authorId?string

Only models by this user.

size?integer

Page size.

Default24
Range1 <= value <= 50
offset?integer

Number of results to skip. Pages can overlap slightly; de-duplicate by id.

Default0
Range0 <= value <= 10000

Response Body

application/json

curl -X GET "https://api.pixai.art/v2/generation-model/search?usageType=ALL"
{
  "data": [
    {
      "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"
        }
      }
    }
  ],
  "hasMore": true
}

List the versions of a model GET

Lists a model's versions, newest first. Pass a version's `id` as `modelVersionId` or `loras[].modelId` to pin an older version.

Get task detail by ID GET

Fetch a generation task by ID to check its status (waiting, running, completed, cancelled or failed) and read the IDs and URLs of the media it produced.