Create Embed Token Endpoint

POST

/maps/{map_id}/embed-tokens/

const url = 'https://example.com/maps/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/embed-tokens/';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"allowed_origins":["https://dashboard.example.com"],"expires_in_days":30,"name":"Public dashboard embed"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/maps/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/embed-tokens/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "allowed_origins": [ "https://dashboard.example.com" ], "expires_in_days": 30, "name": "Public dashboard embed" }'

Create an embed token scoped to a map’s current layers.

The default 30-day unrestricted token is always available. Custom lifetimes and non-empty origin restrictions require advanced sharing controls.

Authorizations

Parameters

Path Parameters

map_id

required

Map Id

string format: uuid

Request Body^required

application/json

EmbedTokenCreate

object

allowed_origins

Any of:

Array<string>
null

Array<string>

<= 50 items

expires_in_days

Expires In Days

Token lifetime in days (1-365). The default 30-day lifetime is always available; custom lifetimes require advanced sharing controls.

integer

default: 30 >= 1 <= 365

Example

name

Any of:

string
null

string

>= 1 characters <= 255 characters

Responses

201

Successful Response

application/json

EmbedTokenCreatedResponse

object

allowed_origins

Any of:

Array<string>
null

Array<string>

created_at

required

Created At

string format: date-time

expires_at

required

Expires At

string format: date-time

required

string format: uuid

is_active

required

Is Active

boolean

last_used_at

Any of:

string
null

string format: date-time

map_id

required

Map Id

string format: uuid

name

Any of:

string
null

string

raw_token

required

Raw Token

string

scoped_dataset_ids

required

Scoped Dataset Ids

Array<string>

token_hint

required

Token Hint

string

use_count

Use Count

integer

Example

{
  "use_count": 0
}

400

Bad request — invalid payload

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

401

Unauthorized — missing or invalid credentials

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

403

Forbidden — caller lacks write access

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

404

Not found

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

409

Conflict — resource state prevents the operation

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

422

Validation error

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Too many requests — retry after the advertised interval

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Retry-After

integer

Seconds until the request may be retried

500

Internal server error

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Service unavailable — the database could not serve the request

application/problem+json

ProblemDetail

object

detail

required

Any of:

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Create Embed Token Endpoint

Authorizations

Parameters

Path Parameters

Request Body required

Example

Responses

201

Example

400

Example

401

Example

403

Example

404

Example

409

Example

422

Example

429

Example

Headers

500

Example

503

Example

Request Body^required