---
name: "fetchPixelImageCategoryInfo"
mode: "kit"
versionRequirements:
  - { name: "AIKit", version: "1.8.0" }
  - { name: "@ray-js/ray", version: "1.7.60" }
platform:
  - "iOS"
  - "Android"
async: true
title: "fetchPixelImageCategoryInfo"
---

## fetchPixelImageCategoryInfo

> [VERSION] AIKit >= 1.8.0 | @ray-js/ray >= 1.7.60

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Get image generation tag category list

### Parameters

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `complete` | `() => void` | No | - | Completion callback (executed on both success and failure) |
| `success` | `(params: Object) => void` ↓see below | No | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | Failure callback |

#### success callback parameters

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `imageCategory` | `PixelImageCategoryBean[]` | `1.8.0` | Category information |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Referenced Types

##### `interface` PixelImageCategoryBean

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `categoryName` | `string` | `1.8.0` | Category name |
| `categoryLabel` | `string[]` | `1.8.0` | Category tags |


### Examples

#### Basic usage

```tsx
import { ai } from '@ray-js/ray'

const { fetchPixelImageCategoryInfo } = ai;

fetchPixelImageCategoryInfo({
  success: (result) => {
    console.log('fetchPixelImageCategoryInfo success', result);
  },
  fail: (error) => {
    console.log('fetchPixelImageCategoryInfo fail', error.errorMsg);
  },
});
```