Workspace

Create a workspace and its first API key

Self-serve signup. Returns the API key exactly once — it is stored only as a keyed hash and cannot be retrieved again. Also returns a console session cookie.

post/v1/workspaces

Request

  • Base URL: https://ratchetgate.com
  • URL: https://ratchetgate.com/v1/workspaces
  • Auth: HTTP bearer

Request body

namestring required
emailstring email required

Response

Default Response

workspace_idstring
namestring
api_keystring

OPERATOR key: full scope, for the console and for changing policy. Shown once. Store it securely and do not give it to an agent.

api_key_prefixstring
agent_api_keystring

AGENT key: effects:begin and effects:report only. This is the one to put in your code. It cannot change policy, mint keys, or close a circuit breaker — so an agent holding it cannot switch off its own containment.

agent_api_key_prefixstring
planstring
console_urlstring
next_stepobject

A runnable command using the key just issued, what to expect back, and the follow-up call that new integrations forget.

Changes

No recorded changes to this operation across all 1 revision of this API.