Skip to content
TarekyDocs
Console

Public API: build a tileset from its upload (secret keys)

POST
/v1/tilesets/{name}/builds
curl --request POST \
  --url https://api.tareky.com/v1/tilesets/example/builds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "kind": "vector", "uploadKey": "example", "recipe": { "layer": "data", "minzoom": 0, "maxzoom": "auto", "drop": "densest", "simplification": 1, "include": [ "example" ], "exclude": [ "example" ], "layers": [ { "name": "example", "source": { "file": "example", "layer": "example" }, "minzoom": 1, "maxzoom": 1, "drop": "densest", "simplification": 1, "include": [ "example" ], "exclude": [ "example" ] } ], "tileSize": 256, "format": "png", "quality": 1, "resampling": "nearest", "quantize": 1 }, "options": { "encoding": "auto", "lat": "example", "lng": "example" } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
name
required
string
/^[a-z0-9_-]{1,32}$/

Header Parameters

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

Legacy key id (until its sunset)

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
kind
string
default: vector
Allowed values: vector raster raster-dem
uploadKey
required
string
<= 400 characters
recipe
object
layer
string
default: data /^[a-z0-9_]{1,32}$/
minzoom
integer
0 <= 16
maxzoom
Any of:
integer
<= 16
drop
string
default: densest
Allowed values: densest coalesce cluster
simplification
number
>= 1 <= 20
include
Array<string>
<= 100 items
exclude
Array<string>
<= 100 items
layers
Array<object>
>= 1 items <= 20 items
object
name
required
string
/^[a-z0-9_]{1,32}$/
source
object
file
string
>= 1 characters <= 200 characters
layer
string
>= 1 characters <= 128 characters
minzoom
integer
<= 16
maxzoom
integer
<= 16
drop
string
Allowed values: densest coalesce cluster
simplification
number
>= 1 <= 20
include
Array<string>
<= 100 items
exclude
Array<string>
<= 100 items
tileSize
Any of:
number
Allowed values: 256
format
string
Allowed values: png webp jpeg
quality
integer
>= 1 <= 100
resampling
string
Allowed values: nearest bilinear cubic average
quantize
number
<= 10
options
object
encoding
string
Allowed values: auto utf-8 windows-1256
lat
string
>= 1 characters <= 64 characters
lng
string
>= 1 characters <= 64 characters

Responses

Section titled “Responses”

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"
}