Roles

Get All Roles

get

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Responses

200

Successful Response

application/json

anyOptional

get

/api/v1/roles_and_permissions

HTTPcURLJavaScriptPython

GET /api/v1/roles_and_permissions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

No content

Create Role

post

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Body

application/json

role_namestringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

created_bystringRequired

can_submit_agentany ofOptionalDefault: false

booleanOptional

or

nullOptional

nav_permissionany ofOptional

or

nullOptional

action_permissionany ofOptional

or

nullOptional

is_editableany ofOptionalDefault: true

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

role_idintegerRequired

role_namestringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

created_bystringRequired

can_submit_agentbooleanRequired

is_editablebooleanRequired

422

Validation Error

application/json

post

/api/v1/roles_and_permissions

HTTPcURLJavaScriptPython

POST /api/v1/roles_and_permissions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 290

{
  "role_name": "text",
  "description": "text",
  "created_by": "text",
  "can_submit_agent": false,
  "options": [
    {
      "entity_name": "text",
      "entity_type": "LLMs",
      "entity_id": 1
    }
  ],
  "nav_permission": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "action_permission": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_editable": true
}

{
  "role_id": 1,
  "role_name": "text",
  "description": "text",
  "created_by": "text",
  "can_submit_agent": true,
  "options": [
    {
      "entity_name": "text",
      "entity_type": "LLMs",
      "entity_id": 1
    }
  ],
  "is_editable": true
}

Get Role

get

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

role_idintegerRequired

Responses

200

Successful Response

application/json

role_idintegerRequired

role_namestringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

created_bystringRequired

can_submit_agentbooleanRequired

is_editablebooleanRequired

422

Validation Error

application/json

get

/api/v1/roles_and_permissions/{role_id}

HTTPcURLJavaScriptPython

GET /api/v1/roles_and_permissions/{role_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "role_id": 1,
  "role_name": "text",
  "description": "text",
  "created_by": "text",
  "can_submit_agent": true,
  "options": [
    {
      "entity_name": "text",
      "entity_type": "LLMs",
      "entity_id": 1
    }
  ],
  "is_editable": true
}

Update Role

put

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

role_idintegerRequired

Body

application/json

role_nameany ofOptional

stringOptional

or

nullOptional

can_submit_agentany ofOptional

booleanOptional

or

nullOptional

optionsany ofOptional

or

nullOptional

is_editableany ofOptional

booleanOptional

or

nullOptional

descriptionany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

role_idintegerRequired

role_namestringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

created_bystringRequired

can_submit_agentbooleanRequired

is_editablebooleanRequired

422

Validation Error

application/json

put

/api/v1/roles_and_permissions/{role_id}

HTTPcURLJavaScriptPython

PUT /api/v1/roles_and_permissions/{role_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "role_name": "text",
  "can_submit_agent": true,
  "options": [
    {
      "entity_name": "text",
      "entity_type": "LLMs",
      "entity_id": 1
    }
  ],
  "is_editable": true,
  "description": "text"
}

{
  "role_id": 1,
  "role_name": "text",
  "description": "text",
  "created_by": "text",
  "can_submit_agent": true,
  "options": [
    {
      "entity_name": "text",
      "entity_type": "LLMs",
      "entity_id": 1
    }
  ],
  "is_editable": true
}

Delete Role

delete

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

role_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

delete

/api/v1/roles_and_permissions/{role_id}

HTTPcURLJavaScriptPython

DELETE /api/v1/roles_and_permissions/{role_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get All Custom Agents

get

Get all active custom agents for UI dropdowns.

Used when creating/editing roles to show available CustomAgents options.

Returns: List of active custom agents with basic info

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Responses

200

Successful Response

application/json

anyOptional

get

/api/v1/roles_and_permissions/custom_agents

HTTPcURLJavaScriptPython

GET /api/v1/roles_and_permissions/custom_agents HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

No content

Reassign Users

post

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Query parameters

to_role_idintegerRequired

Bodyobject · RoleOption[]

application/json

entity_namestringRequired

entity_typeany ofOptional

string · enumOptionalPossible values:

or

nullOptional

entity_idany ofOptional

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

post

/api/v1/roles_and_permissions/reassign_users/

HTTPcURLJavaScriptPython

POST /api/v1/roles_and_permissions/reassign_users/?to_role_id=1 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

[
  {
    "entity_name": "text",
    "entity_type": "LLMs",
    "entity_id": 1
  }
]

No content

Get Role By Username

get

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

usernamestringRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/api/v1/roles_and_permissions/get_role_by_username/{username}

HTTPcURLJavaScriptPython

GET /api/v1/roles_and_permissions/get_role_by_username/{username} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Users By Role

get

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

role_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/api/v1/roles_and_permissions/get_users_by_role/{role_id}

HTTPcURLJavaScriptPython

GET /api/v1/roles_and_permissions/get_users_by_role/{role_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Llms By Role

get

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

role_idintegerRequired

Responses

200

Successful Response

application/json

idintegerRequired

model_namestringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

statusany ofOptionalDefault: Inactive

stringOptional

or

nullOptional

is_defaultany ofOptionalDefault: false

booleanOptional

or

nullOptional

connected_atany ofOptional

string · date-timeOptional

or

nullOptional

last_syncany ofOptional

string · date-timeOptional

or

nullOptional

422

Validation Error

application/json

get

/api/v1/roles_and_permissions/llms/{role_id}

HTTPcURLJavaScriptPython

GET /api/v1/roles_and_permissions/llms/{role_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "model_name": "text",
    "description": "text",
    "status": "Inactive",
    "is_default": false,
    "connected_at": "2026-04-01T16:31:02.814Z",
    "last_sync": "2026-04-01T16:31:02.814Z"
  }
]

Get Data Connectors By Role

get

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

role_idintegerRequired

Responses

200

Successful Response

application/json

project_data_connector_idintegerRequired

project_idintegerRequired

data_connector_idintegerRequired

is_enabledbooleanRequired

last_status_change_atstring · date-timeRequired

422

Validation Error

application/json

get

/api/v1/roles_and_permissions/data_connectors/{role_id}

HTTPcURLJavaScriptPython

GET /api/v1/roles_and_permissions/data_connectors/{role_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "project_data_connector_id": 1,
    "project_id": 1,
    "data_connector_id": 1,
    "is_enabled": true,
    "last_status_change_at": "2026-04-01T16:31:02.814Z"
  }
]

Get Files By Role

get

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

role_idintegerRequired

Responses

200

Successful Response

application/json

project_idintegerRequired

uploader_usernamestring · max: 255Required

filenamestring · max: 255Required

storage_pathstring · max: 512Required

file_typeany ofOptional

string · max: 100Optional

or

nullOptional

file_size_bytesany ofOptional

integerOptional

or

nullOptional

processing_statusany ofOptionalDefault: uploaded

string · max: 50Optional

or

nullOptional

file_idintegerRequired

uploaded_atstring · date-timeRequired

422

Validation Error

application/json

get

/api/v1/roles_and_permissions/files/{role_id}

HTTPcURLJavaScriptPython

GET /api/v1/roles_and_permissions/files/{role_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "project_id": 1,
    "uploader_username": "text",
    "filename": "text",
    "storage_path": "text",
    "file_type": "text",
    "file_size_bytes": 1,
    "processing_status": "uploaded",
    "file_id": 1,
    "uploaded_at": "2026-04-01T16:31:02.814Z"
  }
]

Get Devices By Role

get

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

role_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/api/v1/roles_and_permissions/devices/{role_id}

HTTPcURLJavaScriptPython

GET /api/v1/roles_and_permissions/devices/{role_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Custom Agents By Role

get

Get custom agents assigned to a specific role.

Args: role_id: Role ID to get assigned agents for

Returns: List of custom agents assigned to the role

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

role_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/api/v1/roles_and_permissions/custom_agents/{role_id}

HTTPcURLJavaScriptPython

GET /api/v1/roles_and_permissions/custom_agents/{role_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content