Skip to content
Menu
SilktideDevelopers

Get what the account can still add

GET/v1/balances
View as Markdown

Returns what the account can still add under its plan: websites, pages, documents and the other allowances. Call it before creating a website to know how many pages and documents you can give it.

A value of -1 means unlimited. Most fields count what is left, not the total: maxPages is the most pages a new website could be given now, while maxPagesLimit is the account's whole allowance and maxPagesRestOfAccount is what its websites already hold.

To see what one existing website could be given, use Get what a website can be given.

Request
curl "https://api.eu.silktide.com/v1/balances" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
Response: An account with room for 95 more websites
{
  "newWebsites": 95,
  "maxPages": 99810,
  "maxDocuments": 99830,
  "maxAuthentications": 100,
  "maxSearchEngineKeywords": 1000,
  "maxUptimeMonitors": 95,
  "maxUserFlows": 100,
  "maxExperiences": 20,
  "maxPagesLimit": 100000,
  "maxDocumentsLimit": 100000,
  "maxPagesRestOfAccount": 190,
  "maxDocumentsRestOfAccount": 170,
  "governanceAiOptimizersLimit": 3,
  "governanceAiOptimizersUsed": 1
}

Request

No parameters.

Response

200JSON.

  • newWebsitesintegerrequiredat least -1

    How many more websites the account can create.

  • maxPagesintegerrequiredat least -1

    The most pages a new website could be given now.

  • maxDocumentsintegerrequiredat least -1

    The most documents (PDFs) a new website could be given now.

  • maxAuthenticationsintegerrequiredat least -1

    How many more website logins (authentications) the account can add.

  • maxSearchEngineKeywordsintegerrequiredat least -1

    How many more search engine keywords the account can track.

  • maxUptimeMonitorsintegerrequiredat least -1

    How many more uptime monitors the account can add.

  • maxUserFlowsintegerrequiredat least -1

    How many more user flows the account can add.

  • maxExperiencesintegerrequiredat least -1

    How many more experiences the account can add.

  • maxPagesLimitintegerrequiredat least -1

    The account's whole page allowance, across every website.

  • maxDocumentsLimitintegerrequiredat least -1

    The account's whole document (PDF) allowance, across every website.

  • governanceAiOptimizersLimitintegerrequiredat least -1

    How many Governance AI optimizers the account's plan includes. 0 means none.

  • governanceAiOptimizersUsedintegerrequired

    How many Governance AI optimizers are in use, including any still held after a website gave one up.

  • maxPagesRestOfAccountintegerrequired

    Pages already allocated to the account's websites.

  • maxDocumentsRestOfAccountintegerrequired

    Documents already allocated to the account's websites.

Errors

StatusTypeWhen
401NotLoggedInNo API key was sent, or it is not a key for this region.(any operation)
429TooManyRequestsToo many requests to this path in five seconds. Retry after the number of seconds in the Retry-After header, which properties.retryAfter repeats.(any operation)
503-Silktide is busy. Retry after the number of seconds in the Retry-After header.(any operation)

Every error has the same body. See Errors.

Access

Permission
Any user of the account
Plan feature
None
Edition
Silktide 4 and Silktide 5
Cost
Free
Available since
v1.0.0

Try it

Sends a real request to your account from this browser. Your key stays in this tab and goes only to the Silktide API.