Get Estimate

About how many credits scheduled work costs a month, before it is saved: a crawl (projectId, or maxPages and maxTier for one not made yet), a search or an agent (monitorId, or maxCredits). A thing that has run is priced at the average of its last runs; otherwise at the most a run could cost (upTo). Held to monthCap, or the project's or monitor's own monthly cap.

get/api/v1/estimate

Request

  • Base URL: https://api.mesharc.dev (the document declares no server; this is the origin it was published from)
  • URL: https://api.mesharc.dev/api/v1/estimate
  • Auth: none declared

Query parameters

kindstring required
schedulestring required
projectIdstring nullable
monitorIdstring nullable
maxPagesinteger nullable
maxTierstring nullable
maxCreditsinteger nullable
monthCapinteger nullable

Headers

authorizationstring nullable
x-mesharc-tenantstring nullable

Response

Successful Response

kindstring required
schedulestring required
perRuninteger required
runsPerMonthnumber required
perMonthinteger required
cappedboolean required
capinteger required
upToboolean required
basisstring required

Changes

No recorded changes to this operation across all 1 revision of this API.