PLplastic-labs
scopes

Get Or Create Scope

Changed on

Get a Scope by ID or create a new Scope with the given ID.

Returns 201 when the scope is created and 200 when it already exists. A pre-existing peer occupying the scope's reserved internal name is never adopted; that conflict returns 409.

post/v3/workspaces/{workspace_id}/scopes

Request

  • Base URL
    https://api.honcho.dev
  • Auth
    HTTP bearer

Path parameters

workspace_idstring required

Request body

idstring required
metadataobject nullable

Response

Successful Response

idstring required
metadataobject
created_atstring date-time required
session_countinteger nullable

Number of sessions that are active members of this scope. Only returned by the scope list when include_session_count is true.

Changes

  • v3a81991a9e06dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • v3318f8495aa40Revision changes
    • breaking

      the response's property type changed from array to string for status

    • info

      the response property became required for the status