Skip to content
SynupAPI
Get an API key
GETapi.synup.com/api/v4/local-post-ideas/image-credits

Local image credits

Returns the image-generation credit status for a location — monthly limit, used/remaining this month, and any add-on credit pool.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Query

NameTypeRequiredDescription
locationIdstringrequiredRelay-encoded location ID.

Headers

NameTypeRequiredDescription
Synup-VersionstringrequiredAPI version date (YYYY-MM-DD).

Request

Request
curl -X GET 'https://api.synup.com/api/v4/local-post-ideas/image-credits?locationId=' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

Responses

StatusDescription
200Successful response
401Unauthorized - Invalid or missing API key
Example response (generated from the schema)
{
  "data": {
    "localImageCredits": {
      "locationId": "string",
      "monthlyLimit": 0,
      "isActive": true,
      "usedThisMonth": 0,
      "remainingThisMonth": 0,
      "addonPurchased": 0,
      "addonConsumed": 0,
      "addonRemaining": 0
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.localImageCreditsobjectoptional
data.localImageCredits.locationIdstringoptional
data.localImageCredits.monthlyLimitintegeroptional
data.localImageCredits.isActivebooleanoptional
data.localImageCredits.usedThisMonthintegeroptional
data.localImageCredits.remainingThisMonthintegeroptional
data.localImageCredits.addonPurchasedintegeroptional
data.localImageCredits.addonConsumedintegeroptional
data.localImageCredits.addonRemainingintegeroptional