Sign in
Environments

Create an environment

Create a project environment from a host plus, optionally, a standalone server group, a pinned skill selection, and pinned plugin versions. The name must be unique among the project's live environments. Requires project admin.

post/projects/{projectId}/environments

Path parameters

projectIdstring required

ID of the hosted project that contains the server.

Request body

namestring required
descriptionstring
hostIdstring required
serverAttachmentIdstring
modelIdstring

Model to run instead of the host's; omit to inherit the host's. Stored verbatim — no alias canonicalization — so pass exactly the id the provider request should carry.

pluginVersionIdsstring[]

Pinned plugin VERSION IDs. Narrow by design: the plugin must be installed and enabled, the version must be ready, at most one version per plugin may be pinned, and none of its skills may carry supporting files. Not a general-purpose plugin list.

sandboxImageIdstring

Optional sandbox-image pin. Must be a project-shared image; personal drafts are rejected — promote them first.

Response

The created environment.

idstring required
projectIdstring required
namestring required

Unique among the project's live (non-archived) environments.

descriptionstring
hostIdstring required

The host this environment runs against.

serverAttachmentIdstring

Present only when the environment pins a standalone server group; otherwise the host config's own servers apply.

modelIdstring

The environment's model override. ABSENT means the environment INHERITS the model pinned on its host — not that it has no model. Resolve the environment and read effectiveModelId to learn what will actually run.

pluginVersionIdsstring[]

Pinned plugin VERSION IDs. Narrow by design: the plugin must be installed and enabled, the version must be ready, at most one version per plugin may be pinned, and none of its skills may carry supporting files. Not a general-purpose plugin list.

sandboxImageIdstring

Sandbox-image pin: a project-shared image (see the images endpoints) that eval runs in this environment boot a fresh sandbox from. Absent when unpinned.

revisioninteger required

Optimistic-concurrency counter. Pass this back as expectedRevision on the next write; if it no longer matches, the write is rejected with 409 instead of overwriting a concurrent edit.

archivedboolean required

Archived environments cannot be edited or launched until restored.

archivedAtnumber

Unix epoch milliseconds. Present only when archived.

createdAtnumber required

Unix epoch milliseconds.

updatedAtnumber required

Unix epoch milliseconds.

Changes

Changed in 5 of the 122 revisions of this API.9

  • ce6e4188e5582See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 6898f438c65e2See the full diff
    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 552bccab32952See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 968bce2f5a582See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 8e393fd5825f1See the full diff
    • ○

      endpoint added

      endpoint-added