Cesium ion Api API

openapi: 3.0.2

info:
  title: Cesium ion
  version: v1
  description: |
    # Overview

    The Cesium ion REST API allows you to leverage ion's powerful tiling and streaming capabilities from your own applications and workflows. If this is your first time using our APIs, start with the [REST API Tutorial](https://cesium.com/learn/ion/ion-upload-rest/), which covers many of the basics that are not included here.

    The base url of the Cesium ion API server is https://api.cesium.com.

    If you have questions, feedback, or run into any problem, [please reach out](https://cesium.com/contact/support/).

    The APIs described in this documentation are subject to Cesium's [Terms of Service](https://cesium.com/legal/terms-of-service/).

    # Authentication

    All Cesium ion endpoints require authentication in the form of an access token provided in the `Authorization` header of the request. ion uses the OAuth 2.0 `Bearer <your_access_token>` format and supports the following scopes:

    ### Public Scopes

    | Scope | Description |
    | - | - |
    | assets:limited-list | List the metadata for selected assets available to the account. |
    | assets:read | Read metadata and access the tiled data for individual assets in the account. |
    | geocode | Perform geocodes. Not yet available in the REST API. |

    ### Private Scopes

    The following scopes provide potentially sensitive information or otherwise allow changes to be made to your account. They should only be used in cases where the token can be kept secret and unavailable to public clients.

    | Scope | Description |
    | - | - |
    | assets:list | List the metadata for all assets available to the account. |
    | assets:write | Create, modify, and delete assets in the account. |
    | profile:read | Read your username, email address, avatar, and storage quota. |
    | labels:read | List labels in the account. |
    | labels:write | Create, modify, and delete labels in the account. |
    | tokens:read | Read token metadata and list all tokens for the account. |
    | tokens:write | Create, modify, and delete tokens in the account. User access tokens only; not available to OAuth. |
    | archives:read | List and download asset archives. |
    | archives:write | Create and delete asset archives. |
    | exports:read | List asset exports. |
    | exports:write | Export assets. |

    Cesium ion also supports OAuth 2.0 `authorizationCode` flow if you want to allow users to bring their own ion account into your application. NOTE: We require [PKCE authentication](https://oauth.net/2/pkce/) with client Oauth applications. See our [OAuth 2.0 tutorial](https://cesium.com/learn/ion/ion-oauth2/) for more details.

servers:
  - url: https://api.cesium.com
    description: Cesium ion API Server

security:
  - OAuth2: []

tags:
  - name: Assets
    description: |
      Whether you have imagery, terrain, 3D buildings, point clouds, photogrammetry, or one of the many other types of data we support, ion creates what we refer to as an asset.

      There are seven types of assets:

      | Value | Description |
      | - | - |
      | 3DTILES | A [3D Tiles](https://github.com/CesiumGS/3d-tiles) tileset |
      | GLTF | A [glTF](https://github.com/KhronosGroup/glTF/tree/master/specification/2.0) model |
      | IMAGERY | An TMS and WMTS compatible imagery layer |
      | TERRAIN | A [quantized-mesh-1.0](https://github.com/CesiumGS/quantized-mesh) terrain tileset |
      | CZML | A [CZML](https://github.com/AnalyticalGraphicsInc/czml-writer/wiki/CZML-Guide) dataset |
      | KML | A [KML](https://developers.google.com/kml) or KMZ dataset |
      | GEOJSON | A [GeoJSON](https://geojson.org/) dataset |

      The Assets API provides a mechanism to discover, create, and stream these assets into your own applications.

  - name: Asset Elements
    description: |
      The Asset Elements API provides a mechanism to query individual elements within an asset.

  - name: Archives
    description: |
      Archives allow you to make downloadable versions of your assets for offline use or hosting outside of Cesium ion.

      With archives you can:

      * Create a full copy of an asset as a zip file
      * Clip out a subset of a 3D Tiles, terrain, or imagery asset as a glTF model or 3D Tiles 1.1 zip file

      Full asset downloads do not support Asset Depot assets or terrain assets which use a base terrain. Check the [archivable](#operation/getAsset) property of the asset to detect availability.

      <a name="archive-clip-requirements"></a>
      Clips support both your assets and most Asset Depot assets, but have additional restrictions:

      * Clips can only be made from 3D Tiles or terrain & imagery assets.
      * Clips comprised of your assets have a geographic size limit of 200 km^2
      * Clips comprised of Asset Depot assets have a geographic size limit of 25 km^2
      * The number of Clips you can make with Asset Depot assets within a billing period is limited by your plan. See [Cesium ion pricing plans](https://cesium.com/platform/cesium-ion/pricing/) for specific limits.

      Individual archives count against your account storage quota. If your account goes over storage quota, additional archives will not be possible without upgrading your plan or deleting existing archives or assets to free up space.

  - name: Exports
    description: |
      Allows you to export the files for a particular asset to an Amazon S3 bucket of your choice. These files can then be hosted through a custom server or downloaded for local/offline use.

      The number of bytes exported counts against your monthly streaming quota. If your account goes over streaming quota, additional exports will not be possible until the next billing cycle.

      Exports are not supported for certain assets, such as from the Asset Depot or terrain assets which use a base terrain. Check the [exportable](#operation/getAsset) property of the asset to detect availability.

  - name: Labels
    description: |
      Labels let you organize assets and stories with reusable metadata tags.

      The Labels API provides a mechanism to list, create, update, and delete account labels. Asset-label assignment is documented with the asset routes.

  - name: Tokens
    description: |
      The Tokens API provides a mechanism to create and manage access tokens.  Access tokens are used to give applications access to your ion account, including access to stream your ion assets.

      Every account has a single default token with the `assets:read` and `geocode` scopes.  This token cannot be modified or deleted, and provides read access to all assets associated with that user's ion account.

  - name: User
    description: |
      Routes related to the currently authenticated account.

  - name: Oauth
    description: |
      The Oauth API provides a mechanism to allow third-party applications to access a user's ion account data through the Oauth 2.0 authorization framework.

  - name: Experimental
    description: |
      Experimental API lets users test emerging capabilities and help shape future improvements. These endpoints are not intended for production use and may be removed without notice.



# --- truncated at 32 KB (182 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cesium/refs/heads/main/openapi/_original/cesium-api-openapi.yml