Create workspace onboard

POST/workspaces/onboard

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Request body

application/json

namestringrequired

min length 1

slugstringrequired

min length 1

keystring

seedStarterIssuesboolean

Responses

201

Workspace onboarded with default team and admin token

workspaceobjectrequired

Show properties

idstringrequired

namestringrequired

slugstringrequired

keystring | nullrequired

ownerIdstringrequired

defaultTeamIdstring | nullrequired

createdAtstringrequired

updatedAtstringrequired

teamobjectrequired

Show properties

idstringrequired

organizationIdstringrequired

keystringrequired

namestringrequired

ownerIdstringrequired

isDefaultbooleanrequired

isPublicbooleanrequired

parentAutoClosebooleanrequired

triageAssigneeIdstring | nullrequired

defaultTemplateIdstring | nullrequired

subIssueAutoClosebooleanrequired

createdAtstringrequired

updatedAtstringrequired

tokenstringrequired

quickstartobject

Show properties

mcpUrlstringrequired

cliSetupCommandstringrequired

seededIssueIdsstring[]required

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

namestring*slugstring*keystringseedStarterIssuesboolean

Request

curl -X POST 'https://pile.nyc/workspaces/onboard' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "slug": "string",
  "key": "string",
  "seedStarterIssues": true
}'

const response = await fetch("https://pile.nyc/workspaces/onboard", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"slug\": \"string\",\n  \"key\": \"string\",\n  \"seedStarterIssues\": true\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/onboard",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"slug\": \"string\",\n  \"key\": \"string\",\n  \"seedStarterIssues\": true\n}",
)

Response

{
  "workspace": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "key": "string",
    "ownerId": "string",
    "defaultTeamId": "string",
    "createdAt": "string",
    "updatedAt": "string"
  },
  "team": {
    "id": "string",
    "organizationId": "string",
    "key": "string",
    "name": "string",
    "ownerId": "string",
    "isDefault": true,
    "isPublic": true,
    "parentAutoClose": true,
    "triageAssigneeId": "string",
    "defaultTemplateId": "string",
    "subIssueAutoClose": true,
    "createdAt": "string",
    "updatedAt": "string"
  },
  "token": "string",
  "quickstart": {
    "mcpUrl": "string",
    "cliSetupCommand": "string",
    "seededIssueIds": [
      "string"
    ]
  }
}