Skip to content
Indiana
Dashboard
Docs
Browse docs / Read AI pricing

Read AI pricing

POST/api/v1/ai/pricing/read

Read current feature models, prices and markups in this App/environment. Saved configuration applies to new calls; frozen quotes retain original prices.

SDK 0.0.1Updated

Make the request

Read current feature models, prices and markups in this App/environment. Saved configuration applies to new calls; frozen quotes retain original prices.

Credential
Server API key only. Call from your trusted backend.
Permission
credits:read
Set the base URL and App ID from SDK setup. These examples use placeholders and do not execute requests. Never put a server key in browser code.
request.shShell
curl -X POST "$GROOVE_BASE_URL/api/v1/ai/pricing/read" \  -H "Authorization: Bearer $GROOVE_SECRET_KEY" \  -H "X-Groove-Project: $GROOVE_PROJECT_ID" \  -H "X-Groove-Environment: sandbox" \  -H "Content-Type: application/json" \  -d '{  "entitlementId": "00000000-0000-4000-8000-000000000001"}'

The response tab lists field types, not an example payload. Actual values depend on customer state.

Request parameters

JSON body

entitlementIduuidRequired

The entitlementId value for this operation. Its accepted type and constraints are listed above and below.

Response fields

Successful responses include requestId and scope. Use the actual business status or accepted field to determine the result. Optional fields are omitted when unavailable.

HTTP 200 · application/json

requestIduuidRequired

Server-generated HTTP request UUID. Include it when reporting a failed request.

scopeobjectRequired

The App and environment of this response. Headers only verify scope; they cannot switch key scope.

Show child fields
projectIdstringRequired

App ID bound to the credential.

minLength: 1

environmentenumRequired

Separate data scope: sandbox or live.

Show allowed values

"sandbox""live"

entitlementVersionIduuidRequired

The entitlementVersionId value for this operation. Its accepted type and constraints are listed above and below.

configurationobjectRequired

The configuration value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
defaultMarkupnumberRequired

The defaultMarkup value for this operation. Its accepted type and constraints are listed above and below.

min: -100

providerMarkupsobjectRequired

The providerMarkups value for this operation. Its accepted type and constraints are listed above and below.

modelMarkupsobjectRequired

The modelMarkups value for this operation. Its accepted type and constraints are listed above and below.

customModelsobjectRequired

The customModels value for this operation. Its accepted type and constraints are listed above and below.

Handle errors

Common failures
CodeRecovery
UNAUTHENTICATEDVerify the key or refresh the expired customer token once.
FORBIDDENCheck current key permissions and customer access.
INVALID_REQUESTCheck field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCHUse the App and environment bound to the credential.

Common failures

  • UNAUTHENTICATED

    Recovery
    Verify the key or refresh the expired customer token once.
  • FORBIDDEN

    Recovery
    Check current key permissions and customer access.
  • INVALID_REQUEST

    Recovery
    Check field types, UUIDs, decimal strings and mutually exclusive fields.
  • SCOPE_MISMATCH

    Recovery
    Use the App and environment bound to the credential.

Related:All request and error conventions·Back to endpoint index