Namirasoft Expert API V1
Namira Software Corporation Expert API Version 1 (1.4.31)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-expert-api-v1
Commands
Healthz
Get
Returns the application health status
ns-expert healthz get
Health
Liveness
Returns the application liveness status
ns-expert health liveness
Readiness
Returns the application readiness status
ns-expert health readiness
Metrics
Get
Returns the application metrics
ns-expert metrics get
Value
List
Returns the value list of a given table and column
ns-expert value list {table} {column} {search} {field_id} {limit}
AgentCategory
List
Returns the agent category list
ns-expert agentcategory list {filters} {page} {size} {sorts}
Get
Returns a agent category by id.
ns-expert agentcategory get {id}
Create
Creates a new agent category for an entity
ns-expert agentcategory create
--category_id (String)
Delete
Deletes a agent category by an id.
ns-expert agentcategory delete {id}
AgentField
List
Returns the agent field list
ns-expert agentfield list {filters} {page} {size} {sorts}
Get
Returns a agent field by id.
ns-expert agentfield get {id}
Create
Creates a new agent field for an entity
ns-expert agentfield create
--field_id (String)
--value (Any)
Update
Updates a agent field by an id for an entity
ns-expert agentfield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a agent field by an id.
ns-expert agentfield delete {id}
AgentTag
List
Returns the agent tag list
ns-expert agenttag list {filters} {page} {size} {sorts}
Get
Returns a agent tag by id.
ns-expert agenttag get {id}
Create
Creates a new agent tag for an entity
ns-expert agenttag create
--name (String)
--value (String)
Update
Updates a agent tag by an id for an entity
ns-expert agenttag update {id}
--name (String)
--value (String)
Delete
Deletes a agent tag by an id.
ns-expert agenttag delete {id}
Description
List
Returns the list of description for an entity_type by an agent_id
ns-expert description list {agent_id} {entity_type} {filters} {page} {size} {sorts}
Update
Updates a description by an agent_id and id
ns-expert description update {agent_id} {id}
--description (String)
Delete
Deletes a descriptionby an agent_id and id
ns-expert description delete {agent_id} {id}
Generate
Creates new descriptions for an entity_type by an agent_id
ns-expert description generate {agent_id} {entity_type}
Track
Tracks a state with a track_id
ns-expert description track {track_id}
RoleAssignment
List
Returns the list of description for an entity_type by an agent_id
ns-expert roleassignment list {agent_id} {entity_type} {filters} {page} {size} {sorts}
Create
Creates a new role assignment for entity_type by an agent_id
ns-expert roleassignment create {agent_id} {entity_type}
--entity_id (String)
--role_id (String)
Delete
Deletes a role assignment by an agent_id and id
ns-expert roleassignment delete {agent_id} {id}
Generate
Generates new role assignments for an agent by entity_type
ns-expert roleassignment generate {agent_id} {entity_type}
Track
Tracks a state with a track_id
ns-expert roleassignment track {track_id}
Role
List
Returns the list of roles for an entity_type by an agent_id
ns-expert role list {agent_id} {entity_type} {filters} {page} {size} {sorts}
Create
Creates a new role for entity_type by an agent_id
ns-expert role create {agent_id} {entity_type}
--name (Any)
Generate
Generates new roles for an agent by entity_type
ns-expert role generate {agent_id} {entity_type}
Track
Tracks a state with a track_id
ns-expert role track {track_id}
Update
Updates a role cache by an agent_id and id
ns-expert role update {agent_id} {id}
--name (Any)
Delete
Deletes a role by an agent_id and id
ns-expert role delete {agent_id} {id}
Agent
List
Returns the agent list
ns-expert agent list {filters} {page} {size} {sorts}
Get
Returns an agent by an id
ns-expert agent get {id}
Create
Creates a new agent
ns-expert agent create
--workspace_id (String)
--project_id (String)
--environment_id (String)
--target_topic_id (String)
--name (String)
--cloud_ids (Any)
--server_ids (Any)
--kubernetes_ids (Any)
--docker_ids (Any)
--database_ids (Any)
--cache_ids (Any)
--messaging_ids (Any)
--streaming_ids (Any)
--metric_ids (Any)
--maximum_cost_per_chat (Float)
--maximum_cost_per_run (Float)
--description (String)
--agent_category (Array)
--agent_field (Array)
--agent_tag (Array)
Update
Updates an agent by an id
ns-expert agent update {id}
--workspace_id (String)
--project_id (String)
--environment_id (String)
--target_topic_id (String)
--name (String)
--cloud_ids (Any)
--server_ids (Any)
--kubernetes_ids (Any)
--docker_ids (Any)
--database_ids (Any)
--cache_ids (Any)
--messaging_ids (Any)
--streaming_ids (Any)
--metric_ids (Any)
--maximum_cost_per_chat (Float)
--maximum_cost_per_run (Float)
--description (String)
--agent_category (Array)
--agent_field (Array)
--agent_tag (Array)
Delete
Deletes an agent by an id
ns-expert agent delete {id}
Chat
List
Returns the chat list
ns-expert chat list {filters} {page} {size} {sorts}
Update
Updates a chat by an id
ns-expert chat update {id}
--workspace_id (String)
--agent_id (String)
--incident_id (String)
--type (Enum)
--name (String)
--description (String)
--cloud (Boolean)
--server (Boolean)
--kubernetes (Boolean)
--docker (Boolean)
--database (Boolean)
--cache (Boolean)
--messaging (Boolean)
--streaming (Boolean)
--metric (Boolean)
--cloud_ids (Any)
--server_ids (Any)
--kubernetes_ids (Any)
--docker_ids (Any)
--database_ids (Any)
--cache_ids (Any)
--messaging_ids (Any)
--streaming_ids (Any)
--metric_ids (Any)
Run
List
Returns the run list
ns-expert run list {filters} {page} {size} {sorts}
Create
Creates a new run
ns-expert run create
--workspace_id (String)
--chat_id (String)
--message_user (String)
--message_ai (String)
--agent_id (String)
--incident_id (String)
--type (Enum)
--name (String)
--description (String)
--cloud (Boolean)
--server (Boolean)
--kubernetes (Boolean)
--docker (Boolean)
--database (Boolean)
--cache (Boolean)
--messaging (Boolean)
--streaming (Boolean)
--metric (Boolean)
--cloud_ids (Any)
--server_ids (Any)
--kubernetes_ids (Any)
--docker_ids (Any)
--database_ids (Any)
--cache_ids (Any)
--messaging_ids (Any)
--streaming_ids (Any)
--metric_ids (Any)
--agent_category (Array)
--agent_field (Array)
--agent_tag (Array)
Schemas
AgentCategory
{ "name": "AgentCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityCategoryInput
{ "name": "EntityCategoryInput", "type": "Object", "required": true, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } }}
AgentField
{ "name": "AgentField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityFieldInput
{ "name": "EntityFieldInput", "type": "Object", "required": true, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } }}
AgentTag
{ "name": "AgentTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityTagInput
{ "name": "EntityTagInput", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } }}
Description
{ "name": "Description", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true }, "user_id": { "type": "String", "required": true }, "agent_id": { "type": "String", "required": true }, "entity_type": { "name": "DescriptionEntityType", "type": "Enum", "required": true, "valids": [ "Cloud_AWS", "Cloud_Azure", "Cloud_GCP", "Server", "Kubernetes", "Docker", "Database", "Cache", "Messaging", "Streaming", "Metric" ] }, "entity_id": { "type": "String", "required": true }, "entity": { "type": "Any", "required": false }, "description": { "type": "String", "required": false }, "manually": { "type": "Boolean", "required": true }, "created_at": { "type": "DateTime", "required": true } }}
DescriptionInput
{ "name": "DescriptionInput", "type": "Object", "required": true, "fields": { "description": { "type": "String", "required": false } }}
RoleAssignment
{ "name": "RoleAssignment", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true }, "user_id": { "type": "String", "required": true }, "agent_id": { "type": "String", "required": true }, "entity_type": { "name": "RoleAssignmentEntityType", "type": "Enum", "required": true, "valids": [ "Cloud_AWS", "Cloud_Azure", "Cloud_GCP", "Server", "Kubernetes", "Docker", "Database", "Cache", "Messaging", "Streaming", "Metric" ] }, "entity_id": { "type": "String", "required": true }, "entity_name": { "type": "String", "required": true }, "role_id": { "type": "String", "required": true }, "role_name": { "type": "String", "required": true }, "manually": { "type": "Boolean", "required": true }, "created_at": { "type": "DateTime", "required": true } }}
RoleAssignmentInput
{ "name": "RoleAssignmentInput", "type": "Object", "required": true, "fields": { "entity_id": { "type": "String", "required": true }, "role_id": { "type": "String", "required": true } }}
Role
{ "name": "Role", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true }, "user_id": { "type": "String", "required": true }, "agent_id": { "type": "String", "required": true }, "entity_type": { "name": "RoleEntityType", "type": "Enum", "required": true, "valids": [ "Cloud_AWS", "Cloud_Azure", "Cloud_GCP", "Server", "Kubernetes", "Docker", "Database", "Cache", "Messaging", "Streaming", "Metric" ] }, "name": { "type": "Any", "required": true }, "manually": { "type": "Boolean", "required": true }, "created_at": { "type": "DateTime", "required": true } }}
RoleInput
{ "name": "RoleInput", "type": "Object", "required": true, "fields": { "name": { "type": "Any", "required": true } }}
Agent
{ "name": "Agent", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "project_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "environment_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "target_topic_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "cloud_ids": { "type": "Any", "required": false }, "server_ids": { "type": "Any", "required": false }, "kubernetes_ids": { "type": "Any", "required": false }, "docker_ids": { "type": "Any", "required": false }, "database_ids": { "type": "Any", "required": false }, "cache_ids": { "type": "Any", "required": false }, "messaging_ids": { "type": "Any", "required": false }, "streaming_ids": { "type": "Any", "required": false }, "metric_ids": { "type": "Any", "required": false }, "maximum_cost_per_chat": { "type": "Float", "required": false }, "maximum_cost_per_run": { "type": "Float", "required": false }, "description": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
AgentInput
{ "name": "AgentInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "project_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "environment_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "target_topic_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "cloud_ids": { "type": "Any", "required": false }, "server_ids": { "type": "Any", "required": false }, "kubernetes_ids": { "type": "Any", "required": false }, "docker_ids": { "type": "Any", "required": false }, "database_ids": { "type": "Any", "required": false }, "cache_ids": { "type": "Any", "required": false }, "messaging_ids": { "type": "Any", "required": false }, "streaming_ids": { "type": "Any", "required": false }, "metric_ids": { "type": "Any", "required": false }, "maximum_cost_per_chat": { "type": "Float", "required": false }, "maximum_cost_per_run": { "type": "Float", "required": false }, "description": { "type": "String", "required": true, "max": 255 }, "agent_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "agent_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "agent_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
Chat
{ "name": "Chat", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "agent_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "incident_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "type": { "name": "ChatType", "type": "Enum", "required": true, "valids": [ "DescriptionWriter", "RoleGenerator", "RoleAssigner", "IncidentAnalyzer" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": true, "max": 255 }, "cloud": { "type": "Boolean", "required": true }, "server": { "type": "Boolean", "required": true }, "kubernetes": { "type": "Boolean", "required": true }, "docker": { "type": "Boolean", "required": true }, "database": { "type": "Boolean", "required": true }, "cache": { "type": "Boolean", "required": true }, "messaging": { "type": "Boolean", "required": true }, "streaming": { "type": "Boolean", "required": true }, "metric": { "type": "Boolean", "required": true }, "total_token": { "type": "Integer", "required": true }, "total_token_input": { "type": "Integer", "required": true }, "total_token_output": { "type": "Integer", "required": true }, "total_cost": { "type": "Integer", "required": true }, "cloud_ids": { "type": "Any", "required": false }, "server_ids": { "type": "Any", "required": false }, "kubernetes_ids": { "type": "Any", "required": false }, "docker_ids": { "type": "Any", "required": false }, "database_ids": { "type": "Any", "required": false }, "cache_ids": { "type": "Any", "required": false }, "messaging_ids": { "type": "Any", "required": false }, "streaming_ids": { "type": "Any", "required": false }, "metric_ids": { "type": "Any", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
ChatInput
{ "name": "ChatInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "agent_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "incident_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "type": { "name": "ChatType", "type": "Enum", "required": true, "valids": [ "DescriptionWriter", "RoleGenerator", "RoleAssigner", "IncidentAnalyzer" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": true, "max": 255 }, "cloud": { "type": "Boolean", "required": true }, "server": { "type": "Boolean", "required": true }, "kubernetes": { "type": "Boolean", "required": true }, "docker": { "type": "Boolean", "required": true }, "database": { "type": "Boolean", "required": true }, "cache": { "type": "Boolean", "required": true }, "messaging": { "type": "Boolean", "required": true }, "streaming": { "type": "Boolean", "required": true }, "metric": { "type": "Boolean", "required": true }, "cloud_ids": { "type": "Any", "required": false }, "server_ids": { "type": "Any", "required": false }, "kubernetes_ids": { "type": "Any", "required": false }, "docker_ids": { "type": "Any", "required": false }, "database_ids": { "type": "Any", "required": false }, "cache_ids": { "type": "Any", "required": false }, "messaging_ids": { "type": "Any", "required": false }, "streaming_ids": { "type": "Any", "required": false }, "metric_ids": { "type": "Any", "required": false } }}
Run
{ "name": "Run", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "chat_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "message_user": { "type": "String", "required": true, "max": 255 }, "message_ai": { "type": "String", "required": true, "max": 255 }, "status": { "name": "RunStatus", "type": "Enum", "required": true, "valids": [ "Pending", "Running", "Successful", "Failed" ] }, "total_token": { "type": "Integer", "required": true }, "total_token_input": { "type": "Integer", "required": true }, "total_token_output": { "type": "Integer", "required": true }, "total_cost": { "type": "Integer", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "agent_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "incident_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "type": { "name": "ChatType", "type": "Enum", "required": true, "valids": [ "DescriptionWriter", "RoleGenerator", "RoleAssigner", "IncidentAnalyzer" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": true, "max": 255 }, "cloud": { "type": "Boolean", "required": true }, "server": { "type": "Boolean", "required": true }, "kubernetes": { "type": "Boolean", "required": true }, "docker": { "type": "Boolean", "required": true }, "database": { "type": "Boolean", "required": true }, "cache": { "type": "Boolean", "required": true }, "messaging": { "type": "Boolean", "required": true }, "streaming": { "type": "Boolean", "required": true }, "metric": { "type": "Boolean", "required": true }, "cloud_ids": { "type": "Any", "required": false }, "server_ids": { "type": "Any", "required": false }, "kubernetes_ids": { "type": "Any", "required": false }, "docker_ids": { "type": "Any", "required": false }, "database_ids": { "type": "Any", "required": false }, "cache_ids": { "type": "Any", "required": false }, "messaging_ids": { "type": "Any", "required": false }, "streaming_ids": { "type": "Any", "required": false }, "metric_ids": { "type": "Any", "required": false } }}
RunInput
{ "name": "RunInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "chat_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "message_user": { "type": "String", "required": true, "max": 255 }, "message_ai": { "type": "String", "required": true, "max": 255 }, "agent_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "incident_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "type": { "name": "ChatType", "type": "Enum", "required": false, "valids": [ "DescriptionWriter", "RoleGenerator", "RoleAssigner", "IncidentAnalyzer" ] }, "name": { "type": "String", "required": false, "max": 255 }, "description": { "type": "String", "required": false, "max": 255 }, "cloud": { "type": "Boolean", "required": false }, "server": { "type": "Boolean", "required": false }, "kubernetes": { "type": "Boolean", "required": false }, "docker": { "type": "Boolean", "required": false }, "database": { "type": "Boolean", "required": false }, "cache": { "type": "Boolean", "required": false }, "messaging": { "type": "Boolean", "required": false }, "streaming": { "type": "Boolean", "required": false }, "metric": { "type": "Boolean", "required": false }, "cloud_ids": { "type": "Any", "required": false }, "server_ids": { "type": "Any", "required": false }, "kubernetes_ids": { "type": "Any", "required": false }, "docker_ids": { "type": "Any", "required": false }, "database_ids": { "type": "Any", "required": false }, "cache_ids": { "type": "Any", "required": false }, "messaging_ids": { "type": "Any", "required": false }, "streaming_ids": { "type": "Any", "required": false }, "metric_ids": { "type": "Any", "required": false }, "agent_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "agent_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "agent_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
Enums
EntityType
Cloud_AWS
Cloud_Azure
Cloud_GCP
Server
Kubernetes
Docker
Database
Cache
Messaging
Streaming
Metric
DescriptionEntityType
Cloud_AWS
Cloud_Azure
Cloud_GCP
Server
Kubernetes
Docker
Database
Cache
Messaging
Streaming
Metric
RoleAssignmentEntityType
Cloud_AWS
Cloud_Azure
Cloud_GCP
Server
Kubernetes
Docker
Database
Cache
Messaging
Streaming
Metric
RoleEntityType
Cloud_AWS
Cloud_Azure
Cloud_GCP
Server
Kubernetes
Docker
Database
Cache
Messaging
Streaming
Metric
ChatType
DescriptionWriter
RoleGenerator
RoleAssigner
IncidentAnalyzer
RunStatus
Pending
Running
Successful
Failed
Namira Software Corporation
©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.