Sign in
Resources

Get an existing resource.

Changed on
get/v2/resources/{air}

Request

  • The document declares no server URL.
  • Auth: none required

Path parameters

airstring required

A unique ID for the resource being requested. See https://developer.civitai.com/docs/getting-started/ai-resource-identifier for more info on AIRs.

Response

OK

airstring required
sizeinteger required

In bytes.

hashesobject required
downloadUrlsstring[] required
resourceNamestring nullable
versionNamestring nullable
invalidateAtstring date-time nullable
earlyAccessEndsAtstring date-time nullable
checkPermissionboolean required

Whether permission is required to use this resource.

canGenerateboolean required
freeTrialLimitinteger nullable

Per-user limit on uses while the resource is in early access.

requiresAuthorizationboolean nullable
fileFormat'unknown' | 'safeTensor' | 'pickleTensor' | 'diffusers' | 'coreML' | 'onnx' | 'tar' required
hasMatureContentRestrictionboolean required

Generations using this resource are forced to not produce mature content.

popularityRanknumber double nullable

0-1.

isFeaturedboolean nullable
publishedAtstring date-time nullable
hasNSFWContentRestrictionboolean required

NSFW covers X and XXX, whereas mature content also includes R.

payoutEnabledboolean nullable

False makes the resource ineligible for compensation.

userIdinteger nullable

The owner of this resource, stamped onto compensation records at flush time so attribution follows ownership transfers instead of being resolved retroactively.

isPromotedboolean nullable

Promoted resources download in the High lane for free, whatever lane the job asked for.

evictableboolean nullable

When false, workers keep the cluster's last copy of this resource rather than evicting it.

tipsEnabledboolean nullable

Unlike payoutEnabled, a licensing fee does not disqualify the resource from tips.

Changes