User APIs
groups

Create Group

Changed on

Create new group, optionally setting its MCP period limit, MCP access and Block role in the same request.

post/api/v1/groups/

Request

  • Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
  • URL: https://carbonarc.ai/api/v1/groups/
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Request body

namestring required
descriptionstring nullable
transaction_limitnumber nullable
allocated_amountnumber nullable
client_idstring uuid required
is_defaultboolean nullable
is_activeboolean nullable
meta_dataobject nullable
user_idsstring[] nullable
block_role'block_user' | 'block_admin'

Additive Block role values stored directly on users.block_role and groups.block_role (block_role_enum Postgres enum). Matches the snake_case value set used elsewhere in the Block domain.

mcp_period_limitnumber nullable
mcp_access_revokedboolean nullable

Response

Successful Response

namestring required
descriptionstring nullable
transaction_limitnumber nullable
allocated_amountnumber nullable
client_idstring uuid required
is_defaultboolean nullable
is_activeboolean nullable
meta_dataobject nullable
user_idsstring[] nullable
block_role'block_user' | 'block_admin'

Additive Block role values stored directly on users.block_role and groups.block_role (block_role_enum Postgres enum). Matches the snake_case value set used elsewhere in the Block domain.

idstring uuid required
keystring required
current_consumptionnumber nullable
mcp_period_limitnumber nullable
mcp_period_consumptionnumber nullable
mcp_period_reset_datestring date-time nullable
mcp_period_next_reset_datestring date-time nullable
mcp_period_start_datestring date-time nullable
mcp_access_revokedboolean nullable
mcp_access_revoked_atstring date-time nullable

Changes

  • a8ca30023371Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status