Skip to content
TarekyDocs
Console

Which features this app install should use (the Android Auto map renderer)

GET
/v1/client-config
curl --request GET \
  --url https://api.tareky.com/v1/client-config \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
x-access-key-id
string

Legacy key id (until its sunset)

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
version
required

Shape of this answer; a client ignores fields it does not know

integer
>= -9007199254740991 <= 9007199254740991
carRenderer
required
object
renderer
required

The renderer to use. maplibre is the safe default

string
Allowed values: godot maplibre
reason
required

Why: kill-switch (the 3D renderer is off for everybody), allowlist (this install or account is listed), rollout (this install is inside the percentage), off (not selected)

string
Allowed values: kill-switch allowlist rollout off
download
required

When the app may fetch the 3D renderer module: any network, unmetered only, or never

string
Allowed values: auto unmetered never
abis
required

CPU ABIs the renderer is built for

Array<string>
minSdk
required

Lowest Android SDK level that may try it

integer
>= -9007199254740991 <= 9007199254740991
minRamMb
required

Least device RAM, in MB, that may try it

integer
>= -9007199254740991 <= 9007199254740991
denyModels
required

Device model globs (* wildcard) that always use MapLibre

Array<string>
denyGpus
required

GPU name globs (* wildcard) that always use MapLibre

Array<string>
breaker
required

The per-device circuit breaker

object
maxFailures
required

Failures inside the window that switch the 3D renderer off on this device

integer
>= -9007199254740991 <= 9007199254740991
windowDays
required

Length of that window

integer
>= -9007199254740991 <= 9007199254740991
epoch
required

Raise it to clear every device’s failure count and let them try again

integer
>= -9007199254740991 <= 9007199254740991
fps
required

Frame-rate limits

object
target
required

Frame rate to aim for

integer
>= -9007199254740991 <= 9007199254740991
floor
required

Median frame rate under which the renderer is failing

integer
>= -9007199254740991 <= 9007199254740991
floorSeconds
required

How long it may stay under the floor before the app falls back

integer
>= -9007199254740991 <= 9007199254740991
telemetry
required
object
enabled
required

Whether the app may send POST /v1/telemetry/car-renderer

boolean
camera
required

Camera presets: none yet, reserved

object
Example
{
  "carRenderer": {
    "renderer": "godot",
    "reason": "kill-switch",
    "download": "auto"
  }
}

429

Section titled “429”

Rate limit or monthly quota exceeded; see Retry-After

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable code, e.g. quota_exceeded, no_route

string
message
required
string
status
required
integer
>= -9007199254740991 <= 9007199254740991
details

For invalid_request: the validation issues

docsUrl
required
string
requestId
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "status": 1,
    "details": "example",
    "docsUrl": "example"
  },
  "requestId": "example"
}

default

Section titled “default”

Any other error, in the /v1 error envelope

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable code, e.g. quota_exceeded, no_route

string
message
required
string
status
required
integer
>= -9007199254740991 <= 9007199254740991
details

For invalid_request: the validation issues

docsUrl
required
string
requestId
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "status": 1,
    "details": "example",
    "docsUrl": "example"
  },
  "requestId": "example"
}