Skip to content
Menu
SilktideDevelopers

Get what a website can be given

GET/v1/balances/{websiteId}
View as Markdown

Returns what one existing website can be given: the most pages and documents you can set when you update it, and the account's other allowances.

maxPages and maxDocuments are never lower than what the website already holds, even when the account is over its allowance, so keeping a website's current allocation always saves. -1 means unlimited.

Request
curl "https://api.eu.silktide.com/v1/balances/2" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
Response: A website that could grow to 1,000 pages
{
  "maxPages": 1000,
  "maxDocuments": 500,
  "maxAuthentications": 100,
  "maxSearchEngineKeywords": 1000,
  "maxUptimeMonitors": 95,
  "maxUserFlows": 100,
  "maxExperiences": 20,
  "maxPagesLimit": 100000,
  "maxDocumentsLimit": 100000,
  "maxPagesRestOfAccount": 180,
  "maxDocumentsRestOfAccount": 160,
  "governanceAiOptimizersLimit": 3,
  "governanceAiOptimizersUsed": 1
}

Request

Path parameters

  • websiteIdintegerrequiredat least 1

    The website.

Response

200JSON.

  • maxPagesintegerrequiredat least -1

    The most pages this website can be given. Never less than it holds now.

  • maxDocumentsintegerrequiredat least -1

    The most documents (PDFs) this website can be given. Never less than it holds 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 allocated to the account's other websites.

  • maxDocumentsRestOfAccountintegerrequired

    Documents allocated to the account's other websites.

Errors

StatusTypeWhen
404ModelNotFoundNothing with that id exists in the account, or the API key's user cannot see it.
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.