List maps

List maps visible in the current workspace, each with the packs simforge maps pull would download and their sizes. Without a credential: the public catalogue, the maps any signed-in account may download

GET /api/v1/maps

List maps

cURL

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

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "version": "<string>",
      "displayName": "<string>",
      "public": true,
      "capabilities": {
        "render2d": true,
        "render3d": true
      },
      "packs": [
        {
          "variant": "3d",
          "version": "<string>",
          "downloadBytes": 1,
          "installedBytes": 1
        }
      ]
    }
  ],
  "nextCursor": "<string>"
}

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.

Query Parameters

cursor · string

Minimum string length: 1

limit · integer · default: 50

Required range: 1 <= x <= 100

Response

200

application/json

Maps.

data · object[] · required

Show child attributes

nextCursor · string | null · required