Namirasoft Inference API V1
Namira Software Corporation Inference API Version 1 (1.4.1)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-inference-api-v1
Commands
Healthz
Get
Returns the application health status
ns-inference healthz get
Health
Liveness
Returns the application liveness status
ns-inference health liveness
Readiness
Returns the application readiness status
ns-inference health readiness
Metrics
Get
Returns the application metrics
ns-inference metrics get
Value
List
Returns the value list of a given table and column
ns-inference value list {table} {column} {search} {field_id} {limit}
ModelCategory
List
Returns the model category list
ns-inference modelcategory list {filters} {page} {size} {sorts}
Get
Returns a model category by id.
ns-inference modelcategory get {id}
Create
Creates a new model category for an entity
ns-inference modelcategory create
--category_id (String)
Delete
Deletes a model category by an id.
ns-inference modelcategory delete {id}
ModelField
List
Returns the model field list
ns-inference modelfield list {filters} {page} {size} {sorts}
Get
Returns a model field by id.
ns-inference modelfield get {id}
Create
Creates a new model field for an entity
ns-inference modelfield create
--field_id (String)
--value (Any)
Update
Updates a model field by an id for an entity
ns-inference modelfield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a model field by an id.
ns-inference modelfield delete {id}
ModelTag
List
Returns the model tag list
ns-inference modeltag list {filters} {page} {size} {sorts}
Get
Returns a model tag by id.
ns-inference modeltag get {id}
Create
Creates a new model tag for an entity
ns-inference modeltag create
--name (String)
--value (String)
Update
Updates a model tag by an id for an entity
ns-inference modeltag update {id}
--name (String)
--value (String)
Delete
Deletes a model tag by an id.
ns-inference modeltag delete {id}
Model
List
Returns the model list
ns-inference model list {filters} {page} {size} {sorts}
Get
Returns a model by an id
ns-inference model get {id}
Create
Creates a new model
ns-inference model create
--workspace_id (String)
--name (String)
--model_company (Enum)
--model_name (Enum)
--model_api_key_credential_id (String)
--cost_limit_per_month (Float)
--cost_limit_per_week (Float)
--cost_limit_per_day (Float)
--cost_limit_per_chat (Float)
--cost_limit_per_run (Float)
--model_category (Array)
--model_field (Array)
--model_tag (Array)
Update
Updates a model by an id
ns-inference model update {id}
--workspace_id (String)
--name (String)
--model_company (Enum)
--model_name (Enum)
--model_api_key_credential_id (String)
--cost_limit_per_month (Float)
--cost_limit_per_week (Float)
--cost_limit_per_day (Float)
--cost_limit_per_chat (Float)
--cost_limit_per_run (Float)
--model_category (Array)
--model_field (Array)
--model_tag (Array)
Delete
Deletes a model by an id
ns-inference model delete {id}
Ask
Asks an LLM in the context of a chat. Creates a new chat if chat_id is null.
ns-inference model ask {model_id}
--chat_id (String)
--run_id (String)
--message (String)
--memory_limit (Integer)
LLM
List
Returns the llm list
ns-inference llm list
Usage
Summary
Returns token usage and cost aggregated over a date interval, optionally filtered by model_id.
ns-inference usage summary {model_id} {started_at} {ended_at}
Schemas
ModelCategory
{ "name": "ModelCategory", "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 } }}
ModelField
{ "name": "ModelField", "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 } }}
ModelTag
{ "name": "ModelTag", "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 } }}
Model
{ "name": "Model", "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 }, "name": { "type": "String", "required": true, "max": 255 }, "model_company": { "name": "ModelModelCompany", "type": "Enum", "required": true, "valids": [ "OpenAI", "Anthropic", "DeepSeek", "Namirasoft" ] }, "model_name": { "name": "ModelModelName", "type": "Enum", "required": true, "valids": [ "Gpt4o", "Gpt4oMini", "Gpt5", "Gpt5Mini", "ClaudeHaiku45", "ClaudeOpus47", "ClaudeSonnet46", "V4Flash", "V4Pro" ] }, "model_api_key_credential_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "cost_limit_per_month": { "type": "Float", "required": false }, "cost_limit_per_week": { "type": "Float", "required": false }, "cost_limit_per_day": { "type": "Float", "required": false }, "cost_limit_per_chat": { "type": "Float", "required": false }, "cost_limit_per_run": { "type": "Float", "required": false }, "total_token": { "type": "Integer", "required": true }, "total_token_input": { "type": "Integer", "required": true }, "total_token_output": { "type": "Integer", "required": true }, "total_paid": { "type": "Integer", "required": true }, "total_paid_input": { "type": "Integer", "required": true }, "total_paid_output": { "type": "Integer", "required": true }, "total_cost": { "type": "Integer", "required": true }, "total_cost_input": { "type": "Integer", "required": true }, "total_cost_output": { "type": "Integer", "required": true }, "total_monthly_started_at": { "type": "DateTime", "required": true }, "total_monthly_token": { "type": "Integer", "required": true }, "total_monthly_token_input": { "type": "Integer", "required": true }, "total_monthly_token_output": { "type": "Integer", "required": true }, "total_monthly_paid": { "type": "Integer", "required": true }, "total_monthly_paid_input": { "type": "Integer", "required": true }, "total_monthly_paid_output": { "type": "Integer", "required": true }, "total_monthly_cost": { "type": "Integer", "required": true }, "total_monthly_cost_input": { "type": "Integer", "required": true }, "total_monthly_cost_output": { "type": "Integer", "required": true }, "total_weekly_started_at": { "type": "DateTime", "required": true }, "total_weekly_token": { "type": "Integer", "required": true }, "total_weekly_token_input": { "type": "Integer", "required": true }, "total_weekly_token_output": { "type": "Integer", "required": true }, "total_weekly_paid": { "type": "Integer", "required": true }, "total_weekly_paid_input": { "type": "Integer", "required": true }, "total_weekly_paid_output": { "type": "Integer", "required": true }, "total_weekly_cost": { "type": "Integer", "required": true }, "total_weekly_cost_input": { "type": "Integer", "required": true }, "total_weekly_cost_output": { "type": "Integer", "required": true }, "total_daily_started_at": { "type": "DateTime", "required": true }, "total_daily_token": { "type": "Integer", "required": true }, "total_daily_token_input": { "type": "Integer", "required": true }, "total_daily_token_output": { "type": "Integer", "required": true }, "total_daily_paid": { "type": "Integer", "required": true }, "total_daily_paid_input": { "type": "Integer", "required": true }, "total_daily_paid_output": { "type": "Integer", "required": true }, "total_daily_cost": { "type": "Integer", "required": true }, "total_daily_cost_input": { "type": "Integer", "required": true }, "total_daily_cost_output": { "type": "Integer", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
ModelInput
{ "name": "ModelInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "model_company": { "name": "ModelModelCompany", "type": "Enum", "required": true, "valids": [ "OpenAI", "Anthropic", "DeepSeek", "Namirasoft" ] }, "model_name": { "name": "ModelModelName", "type": "Enum", "required": true, "valids": [ "Gpt4o", "Gpt4oMini", "Gpt5", "Gpt5Mini", "ClaudeHaiku45", "ClaudeOpus47", "ClaudeSonnet46", "V4Flash", "V4Pro" ] }, "model_api_key_credential_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "cost_limit_per_month": { "type": "Float", "required": false }, "cost_limit_per_week": { "type": "Float", "required": false }, "cost_limit_per_day": { "type": "Float", "required": false }, "cost_limit_per_chat": { "type": "Float", "required": false }, "cost_limit_per_run": { "type": "Float", "required": false }, "model_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "model_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 } } } ] }, "model_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 } } } ] } }}
Interaction
{ "name": "Interaction", "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": true, "min": 20, "max": 20 }, "run_id": { "type": "String", "required": false }, "model_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "message_user": { "type": "String", "required": true }, "message_ai": { "type": "String", "required": true }, "message_error": { "type": "String", "required": false }, "status": { "name": "InteractionStatus", "type": "Enum", "required": true, "valids": [ "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 }, "total_cost_input": { "type": "Integer", "required": true }, "total_cost_output": { "type": "Integer", "required": true }, "duration": { "type": "Integer", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
LLMListResponse
{ "name": "LLMListResponse", "type": "Object", "required": true, "fields": { "count": { "type": "Float", "required": true }, "rows": { "type": "Array", "required": true, "items": [ { "name": "LLMItem", "type": "Object", "required": true, "fields": { "company": { "name": "ModelCompanyType", "type": "Enum", "required": true, "valids": [ "OpenAI", "Anthropic", "DeepSeek", "Namirasoft" ] }, "name": { "type": "String", "required": true }, "price_input": { "type": "Float", "required": true }, "price_output": { "type": "Float", "required": true } } } ] } }}
LLMItem
{ "name": "LLMItem", "type": "Object", "required": true, "fields": { "company": { "name": "ModelCompanyType", "type": "Enum", "required": true, "valids": [ "OpenAI", "Anthropic", "DeepSeek", "Namirasoft" ] }, "name": { "type": "String", "required": true }, "price_input": { "type": "Float", "required": true }, "price_output": { "type": "Float", "required": true } }}
UsageSummaryResponse
{ "name": "UsageSummaryResponse", "type": "Object", "required": true, "fields": { "count": { "type": "Integer", "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 }, "total_cost_input": { "type": "Integer", "required": true }, "total_cost_output": { "type": "Integer", "required": true } }}
Enums
ModelModelCompany
OpenAI
Anthropic
DeepSeek
Namirasoft
ModelModelName
Gpt4o
Gpt4oMini
Gpt5
Gpt5Mini
ClaudeHaiku45
ClaudeOpus47
ClaudeSonnet46
V4Flash
V4Pro
InteractionStatus
Running
Successful
Failed
ModelCompanyType
OpenAI
Anthropic
DeepSeek
Namirasoft
Namira Software Corporation
©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.