Account and discovery
Routes in this group. Authentication, scope and rate limit errors apply to every route and are on the errors page.
GET/capabilities
Read what this server accepts and can return.
- Scope
- None. Any valid credential.
- Rate bucket
read, 240 a minute per key
Request. No body. Any valid credential may call it; it needs no scope.
Returns. The accepted manifest, result and review format ids, the manifest file formats and actions with their size limits, recipes and lanes, batch and unit states, unsupported reasons, and the error code table. The document is built from the planner's own tables and cached per server process. Whether a lane is switched on is not in it; read GET /pricing for that.
GET/me
Describe the credential you are calling with.
- Scope
- None. Any valid credential.
- Rate bucket
read, 240 a minute per key
Request. No body. Any valid credential may call it; it needs no scope.
Returns. kind, the account's internal id, the key's id, prefix and expiry, the scopes, the bound project and the key's credit limits. For a signed-in session key is null and the limit fields are null. Check remainingDailyCredits here before a large submit.
Response model PipelineMe.
| Field | Type | Required | Limits |
|---|---|---|---|
kind | string | Yes | |
user | MeUser | Yes | |
key | MeKey | No | |
scopes | array of string | Yes | |
project | MeProject | No | |
limits | MeLimits | Yes |
GET/pricing
Read the price list, lane availability and your live limits.
- Scope
batches:quote- Rate bucket
read, 240 a minute per key- Availability
- Answers 404 not_found where the streamlining flag is off.
Request. No body. Needs the batches:quote scope. This route answers 404 not_found on a server where the streamlining flag is off.
Returns. currency (credits), lanes with priceCredits and status (free or unpriced), laneStates (on, off or pilot_owner_only per lane), remoteLanePrices for the model lane, retention days, limits (key buckets, plan limits, active batches, credit caps, remaining daily credits, project budget) and cashConversion, which is null: Forge publishes no credit to money rate here.
| Field | Note |
|---|---|
lanes | The price list. status free means priceCredits is 0. status unpriced means priceCredits is null. |
laneStates | Per lane: state on, off or pilot_owner_only, and the environment flag that decides it. |
limits.keyBuckets | Requests per window for the read, write, upload and submit buckets. |
limits.planSubmitsPerHour, limits.activeBatchesPerAccount | Your plan's account limits. The lower of this and the key bucket binds. |
limits.remainingDailyCredits | What is left of this key's daily credit cap. Null when the key has no cap. |
Errors specific to this route. 404 not_found. Authentication, scope and rate limit errors apply to every route.