Skip to content
Plaza Plaza Docs
GuidesBlogPlaygroundDashboard
API Reference
Datasets

Create a new dataset (admin only)

$ plaza datasets create
POST/api/v1/datasets

Create a new dataset (admin only)

ParametersExpand Collapse
--name: string

Human-readable dataset name

--slug: string

URL-friendly identifier (lowercase, hyphens, no spaces)

--attribution: optional string

Required attribution text

--description: optional string

Dataset description

--license: optional string

License identifier (e.g. CC-BY-4.0)

--source-url: optional string

Source data URL

ReturnsExpand Collapse
dataset: object { id, inserted_at, name, 6 more }

Metadata for a custom dataset. Datasets contain user-uploaded geospatial features separate from the OSM data.

id: string

Dataset UUID

inserted_at: string

Creation timestamp (UTC)

name: string

Human-readable dataset name

slug: string

URL-friendly identifier

updated_at: string

Last update timestamp (UTC)

attribution: optional string

Required attribution text

description: optional string

Dataset description

license: optional string

License identifier (e.g. CC-BY-4.0)

source_url: optional string

URL of the original data source

Create a new dataset (admin only)

plaza datasets create \
  --api-key 'My API Key' \
  --name 'NYC Bike Lanes' \
  --slug nyc-bike-lanes
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "inserted_at": "2019-12-27T18:11:19.117Z",
  "name": "NYC Bike Lanes",
  "slug": "nyc-bike-lanes",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "attribution": "attribution",
  "description": "description",
  "license": "license",
  "source_url": "https://example.com"
}
Returns Examples
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "inserted_at": "2019-12-27T18:11:19.117Z",
  "name": "NYC Bike Lanes",
  "slug": "nyc-bike-lanes",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "attribution": "attribution",
  "description": "description",
  "license": "license",
  "source_url": "https://example.com"
}