Nimply Developers
API ReferenceDesigns

Estimate the credits a design run can use

GET
/v1/designs/estimate

Free. Nothing is reserved or charged.

AuthorizationBearer <token>

Workspace API key (nim_live_...)

In: header

Query Parameters

kind*string

Value in

  • "generate"
  • "layers"
sizes?string

Comma-separated size ids (generate). Default: one size.

pages?number

Carousel slides to price. Carousels have at most 7 slides: a higher value is priced as 7.

Range1 <= value <= 10
mode?string

Value in

  • "text"
  • "objects"
  • "everything"
brandKitId?string

Brand kit id (generate): prices in the kit's learned look, when it has one. Default: the channel's kit, else the main kit.

channelId?string

Channel the design is for (generate).

useLearnedStyle?boolean

generate: false prices the run without the brand kit's learned look (as useLearnedStyle: false on generate).

Defaulttrue

Response Body

application/json

curl -X GET "https://example.com/v1/designs/estimate?kind=generate"
{  "kind": "generate",  "creditsMin": 80,  "creditsMax": 290,  "estimatedSeconds": {    "min": 60,    "max": 180  },  "creditsAvailable": 1840}
Empty