Get the usage batch schema the account's terms allow

Which usage batch schema the caller’s latest accepted agreement allows (CLI credential): v2 only under an agreement that lists the v2 records

GET /api/v1/telemetry

Get the usage batch schema the account's terms allow

cURL

curl --request GET \
  --url https://dev.simforge.ai/api/v1/telemetry \
  --header 'Authorization: Bearer <token>'

200

{
  "schema": "simforge.usage-terms/v1",
  "agreementVersion": "<string>",
  "batchSchema": "simforge.usage-batch/v1"
}

Authorizations

Authorization · string · header · required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Response

200

application/json

The account's latest accepted agreement and the batch schema it allows.

schema · enum<string> · required

Available options: simforge.usage-terms/v1

agreementVersion · string | null · required

batchSchema · enum<string> · required

Available options: simforge.usage-batch/v1, simforge.usage-batch/v2