POST/api/v1/projects/<PROJECT_ID>/artboards
Creates a new artboard in the specified project. The artboard ID is server‑generated; omitted fields use schema defaults.
Authentication
Request
- Method: POST
- URL:
/api/v1/projects/<PROJECT_ID>/artboards
Parameters
name
string Artboard name. Default: "Untitled Artboard".
type
"color""image""osm"Background source. Default: "color".
embedding_url
string Public URL for embedding. Default: "".
image_url
string Background image URL (for type="image"). Default: "".
width
number Artboard width in px. Default: 800.
height
number Artboard height in px. Default: 600.
bg_color
string Background color hex. Default: "#ffffff".
osm_lat
number OSM latitude (for type="osm"). Default: 0.
osm_lng
number OSM longitude (for type="osm"). Default: 0.
osm_zoom
number OSM zoom level, min 1. Default: 1.
Initial objects. Default: [].
Response
200 OK: The created Artboard object.400 Bad Request: Validation failed. Returns a formatted error message.401 Unauthorized: API key is missing or invalid.404 Not Found: Project not found or does not belong to the user.500 Internal Server Error: Failed to create Artboard.