How do I create a Data Studio project?
Data Studio is the in-app pipeline builder. A project is its unit of work — an organization-scoped workspace holding your datasets and the configuration over them. Here is how to create and manage one.
A Bearer JWT (notX-API-Key), membership in the organization, theDATA_STUDIO_CREATEpermission, and the data-studio add-on enabled.
1. What a project is
A project is the unit of work in Data Studio: an organization-scoped workspace that holds the datasets you add and the configuration you build over them. Every project belongs to exactly one organization, so the API is organization-scoped and authenticated with a Bearer JWT, not an API key.
2. Create a project
POST /v1/organization/:organizationId/data-studio/projects with a JSON body — only name is required (up to 255 characters); description is optional. You need the DATA_STUDIO_CREATE permission and the data-studio add-on (reading needs only DATA_STUDIO_ACCESS).
curl -X POST \
-H "Authorization: Bearer eyJhbGci..." \
-H "Content-Type: application/json" \
-d '{ "name": "Hotels near Restaurants", "description": "Hospitality clusters in the Randstad" }' \
"https://api.topolab.nl/v1/organization/{organizationId}/data-studio/projects"
The created project comes back with a generated id and starts in draft status, private visibility and unlocked. Keep the id — every other per-project endpoint is keyed by it.
3. Read, update, delete and share
Once created, fetch a project with GET .../projects/:projectId, update it with PUT .../projects/:projectId, and remove it with DELETE .../projects/:projectId (which returns a success message). The PUT body accepts name, description, visibility and the project's workspace configuration — the object that holds layers, processing and output. Adding or removing members (GET/POST .../projects/:projectId/members) requires the DATA_STUDIO_MANAGE permission.
The configuration is where the work livesLayers, transformers and output are all defined inside the workspace configuration you set via PUT — see the add-layers, run-a-pipeline and export articles for each part.
Laatst bijgewerkt 25 juli 2026