---
url: /orchestration/reference/operations/GetResource.md
description: 'GET /v2/resources/{air} — Get an existing resource'
---

> Documentation index: https://developer.civitai.com/llms.txt — every page on this site has a markdown version at its URL + `.md`.

# Get an existing resource

`GET https://orchestration.civitai.com/v2/resources/{air}`

Operation `GetResource` · Resources · Civitai Orchestration API, generated from the published OpenAPI spec ([v2-consumers.json](https://developer.civitai.com/openapi/v2-consumers.json)); the interactive HTML page is this URL without `.md`.

## Authentication

Send `Authorization: Bearer <token>` (the spec's `ApiKey` scheme). See [Authentication](https://developer.civitai.com/orchestration/guide/authentication.md).

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `air` | path | string | yes | A unique ID for the resource being requested. See https://developer.civitai.com/site/guide/air for more info on AIRs. (pattern `^(?!huggingface/).*$`) |

## Responses

### 200 OK

Content type: `application/json`.

Schema `ResourceInfo`.

| Field | Type | Required | Description |
|---|---|---|---|
| `air` | string | yes | (pattern `^(?:urn:)?(?:air:)?(?:(?<ecosystem>[a-zA-Z0-9_\-\/]+):)?(?:(?<type>[a-zA-Z0-9_\-\/]+):)?(?<source>[a-zA-Z0-9_\-\/]+):(?<id>[a-zA-Z0-9_\-\/\.]+)(?:@(?<version>[a-zA-Z0-9_\-\/.=,%+:]+))?(?:\.(?<format>[a-zA-Z0-9_\-]+))?$`) |
| `size` | integer (int64) | yes | In bytes. |
| `hashes` | map of string | yes |  |
| `downloadUrls` | array of string (uri) | yes |  |
| `resourceName` | string, nullable | no |  |
| `versionName` | string, nullable | no |  |
| `invalidateAt` | string (date-time), nullable | no |  |
| `earlyAccessEndsAt` | string (date-time), nullable | no |  |
| `checkPermission` | boolean | yes | Whether permission is required to use this resource. |
| `canGenerate` | boolean | yes |  |
| `freeTrialLimit` | integer (int32), nullable | no | Per-user limit on uses while the resource is in early access. |
| `requiresAuthorization` | boolean, nullable | no |  |
| `fileFormat` | `FileFormat` (one of `unknown`, `safeTensor`, `pickleTensor`, `diffusers`, `coreML`, `onnx`, `tar`) | yes |  |
| `hasMatureContentRestriction` | boolean | yes | Generations using this resource are forced to not produce mature content. |
| `popularityRank` | number (double), nullable | no | 0-1. |
| `isFeatured` | boolean, nullable | no |  |
| `publishedAt` | string (date-time), nullable | no |  |
| `hasNSFWContentRestriction` | boolean | yes | NSFW covers X and XXX, whereas mature content also includes R. |
| `fee` | `ResourceFee` | no | License fee charged per use. |
| `payoutEnabled` | boolean, nullable | no | False makes the resource ineligible for compensation. |
| `fees` | array of `ResourceFee`, nullable | no | The full licensing-fee breakdown; each entry settles to its own recipient |
| `userId` | integer (int32), nullable | no | The owner of this resource, stamped onto compensation records at flush time so attribution follows ownership transfers instead of being resolved retroactively. |
| `availability` | `ResourceAvailability` | no | Whether this resource can be generated with right now, across the whole fleet. |
| `isPromoted` | boolean, nullable | no | Promoted resources download in the High lane for free, whatever lane the job asked for. |
| `evictable` | boolean, nullable | no | When false, workers keep the cluster's last copy of this resource rather than evicting it. |
| `tipsEnabled` | boolean, nullable | no | Unlike payoutEnabled, a licensing fee does not disqualify the resource from tips. |

### 400 Bad Request

Content type: `application/json`.

Schema `ProblemDetails`.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | string, nullable | no |  |
| `title` | string, nullable | no |  |
| `status` | integer (int32), nullable | no |  |
| `detail` | string, nullable | no |  |
| `instance` | string, nullable | no |  |

### 404 Not Found

Content type: `application/json`.

Schema `ProblemDetails` — fields as listed above.