Skip to content
General Augment Docs

Create Workspace

POST
/api/v3/workspaces
curl --request POST \
  --url https://example.com/api/v3/workspaces \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "slug": "example" }'

Create a shared Workspace and its owner membership atomically.

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
X-Admin-Key
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceCreateRequestV3
object
name
required
Name
string
>= 1 characters <= 100 characters
slug
required
Slug
string
<= 80 characters /^[a-z0-9]+(?:-[a-z0-9]+)*$/
Examplegenerated
{
  "name": "example",
  "slug": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceResponseV3
object
id
required
Id
string format: uuid
kind
required
Kind
string
Allowed values: personal shared
name
required
Name
string
role
required
Role
string
Allowed values: owner admin developer viewer
slug
required
Slug
string
status
required
Status
string
Allowed values: active archived
Example
{
  "kind": "personal",
  "role": "owner",
  "status": "active"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}