Create a role - Mihu API Documentation

curl --request POST \ --url https://{subdomain}.mihu.ai/api/v1/workspace/roles \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "Loop Agent", "key": "loop_agent", "product_key": "loop", "scopes": [ "loop.conversations.view", "loop.conversations.reply" ] } '

{ "success": true, "message": "Workspace role created", "data": { "role": { "uuid": "22222222-2222-4222-8222-222222222222", "key": "loop_agent", "name": "Loop Agent", "product_key": "loop", "product_label": "Loop", "scopes": [ "loop.conversations.view", "loop.conversations.reply" ], "members_count": 0, "is_system": false, "created_at": "2026-08-08T20:12:00+00:00", "updated_at": "2026-08-08T20:12:00+00:00" } } }

Authorizations

Authorization

string

header

required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Body

application/json

name

string

required

Name shown to the user

Maximum string length: 255

Example:

"Loop Agent"

key

string

Lowercase letters, digits and underscores; derived from the name when omitted

Maximum string length: 255

Example:

"loop_agent"

product_key

string

Optional; when given, every scope must belong to this product and at least one scope is required

Example:

"loop"

scopes

string[]

Scope keys, all from the same product; omit for a role with no access yet

Example:

[
  "loop.conversations.view",
  "loop.conversations.reply"
]

Response

Role created

success

boolean

Example:

true

message

string

Example:

"Workspace role created"

data

object

Show child attributes