Skip to Content
Workspace and account

Credit estimates

Estimate what a campaign, a build, infrastructure or new accounts will cost in credits. Nothing is charged.

Workspace and account1 endpointKen-Version: 2026-11-02AuthenticationWorkspacesErrors
MarkdownOpenAPI

Headers

The endpoints on this page take these headers. Each endpoint's curl shows the ones it sends.

NameInTypeRequiredDescription
Ken-Versionheaderstring, one of: 2026-11-02, 1.1optionalThe API version, a date in YYYY-MM-DD form. 1.1 is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and 404 where the path exists only in this version. A date that is not a version answers 400 unsupported_version; any other value that is not a version is treated as legacy.
X-Ken-Workspace-Idheaderinteger (int64)optionalThe id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers 400 workspace_required. A workspace you are not a member of answers 404 not_found.

Estimate the credits a job needs

POST/v1/credits/estimatescredit-estimates.create
Permission
Any workspace member except a Network member
Rate limit
12,000 requests a minute per API key

Try it on developer.ken.so

Estimates the credits a job needs before you start it, and their price in US cents (totalAmount). Kenso only computes the estimate: nothing is charged or reserved.

Set kind and send only the fields of that kind:

  • campaign: targetLeads (from 1 to 1,000,000), sequenceSteps (from 1 to 50) and personalization. With campaignId, missing values come from that campaign: its contact limit, step count and personalization setting. Otherwise steps default to 3 and personalization to true. Without targetLeads, the campaign's contact limit below 1,000,000 is priced, else its lead count; targetLeads is required when the campaign has neither. Instead of personalization, send depth to price every lead at a depth on the rate card: bulk, personalized or multichannel. The response names the depth and targetLeads it priced.
  • build: one typical campaign build. It costs 0 while the workspace's free monthly build is left.
  • infra: items, from 1 to 50 purchases of inboxes, domains or LinkedIn accounts. A monthly item counts its first month up front.
  • accounts: accountCount, from 1 to 1,000. Each account costs an estimated 12 credits of research, metered per run, plus about 6 buying committee emails, charged only when found.
  • leads: leadCount, from 1 to 1,000,000, at 1.45 credits a lead: about 3 rows qualified, 1 email found and 1 personalization.
  • places: pages, from 0 to 1,000, at 1 credit a search page of up to 200 places, and opens, from 0 to 100,000. A workspace gets 500 free opens of a place's details, reviews or photos each UTC day, and each open after that costs 0.1 credits. The estimate assumes none of today's free opens is used. Send at least one of pages and opens above 0.

sufficient says whether the workspace can cover the estimate now. Free and bonus credits cannot pay for Kenso inboxes and domains.

Errors:

  • 400 validation_failed: kind is missing or unknown, a value is out of range, or a field belongs to another kind.
  • 404 not_found: campaignId is not a campaign in this workspace.

Open to any workspace member.

Request body

application/json, optional.

FieldTypeRequiredDescription
kindstringrequiredRequired. The job to estimate: campaign, build, infra, accounts, leads or places.
campaignIdinteger (int64)optionalCampaign estimates only: a campaign to read the contact limit, step count and personalization setting from.
targetLeadsinteger (int32)optionalCampaign estimates only: the contacts the campaign should finish with, from 1 to 1,000,000. Without it a campaignId is priced on its contact limit below 1,000,000, else on its lead count; required when the campaign has neither.
sequenceStepsinteger (int32)optionalCampaign estimates only: the number of sequence steps, from 1 to 50. Defaults to the campaign's step count, else 3.
personalizationbooleanoptionalCampaign estimates only: whether Kenso personalizes each contact. Defaults to the campaign's setting, else true.
depthstringoptionalCampaign estimates only: how deep Kenso works each lead, bulk, personalized or multichannel. Send it or personalization, not both. Defaults to personalized when personalization is on, else bulk.
itemsarray of CreditEstimateInfraItemRequestoptionalInfra estimates only: from 1 to 50 purchases.
accountCountinteger (int32)optionalAccounts estimates only: the accounts to add, from 1 to 1,000.
leadCountinteger (int32)optionalLeads estimates only: the leads to import, from 1 to 1,000,000.
pagesinteger (int32)optionalPlaces estimates only: search pages of up to 200 places each, from 0 to 1,000. Send pages or opens above 0.
opensinteger (int32)optionalPlaces estimates only: opens of a place's details, reviews or photos, from 0 to 100,000. The first 500 opens a workspace makes each UTC day are free.
Request
curl -X POST "https://api.ken.so/v1/credits/estimates" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "campaign",
  "campaignId": 812,
  "targetLeads": 1,
  "sequenceSteps": 1,
  "personalization": true,
  "depth": "personalized",
  "items": [
    {
      "action": "ken_inbox_monthly",
      "quantity": 1,
      "registrarPriceUsd": 0.5,
      "renewalPriceUsd": 0.5
    }
  ],
  "accountCount": 1,
  "leadCount": 1,
  "pages": 1,
  "opens": 1
}'

Response 200

data is a CreditEstimate.

Show the 12 response fields and an example

The fields and an example are also on this endpoint's Markdown page.


On this page