Create an environment | Neobits API Documentation

postCreate an environment

Creates an environment in the active workspace. Only name is required. Omitting color selects a random supported theme color. Unknown fields are rejected.

Required service-token scope: environment:write. End-user access is checked against workspace policies. Send a Bearer token and the X-Workspace-Id header.

curl --request POST \
  --url https://api.test.neobits.ai/logic/v1/environments \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'X-Workspace-Id: 019991b1-0000-7000-8000-000000000001' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Test","description":"Integration testing","color":"#2563eb"}'

Request

Headers

Authorization•string
Bearer token authentication using OAuth 2.0 client credentials flow.
Required
X-Workspace-Id•string<uuid>
Active workspace UUID. The authenticated principal must have access to this workspace.
Required

Body

name•string
Nonempty name without leading or trailing whitespace.
Required
description•string
Description. Use null or an empty string to clear it.
Nullable
color•string
A six-digit hex color or one of the supported theme colors. If omitted on creation, a random theme color is persisted.

Response

Headers

Content-Type•string
The content type of the response.

Body

id•string<uuid>
Environment identifier.
Required
workspaceId•string<uuid>
Workspace containing this resource.
Required
name•string
Nonempty name without leading or trailing whitespace.
Required
description•string
Description. Use null or an empty string to clear it.
RequiredNullable
color•string
A six-digit hex color or one of the supported theme colors. If omitted on creation, a random theme color is persisted.
Required
createdAt•string<date-time>
Creation time.
Required
updatedAt•string<date-time>
Last update time.
Required