Namirasoft Squirrel API V1
Namira Software Corporation Squirrel API Version 1 (1.5.4)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-squirrel-api-v1
Copied!
Commands
Health
Liveness
Returns the application liveness status
ns-squirrel health liveness
Copied!
Readiness
Returns the application readiness status
ns-squirrel health readiness
Copied!
Metrics
Get
Returns the application metrics
ns-squirrel metrics get
Copied!
Value
List
Returns the value list of a given table and column
ns-squirrel value list {table} {column} {search} {field_id} {limit}
Copied!
Agent
List
Returns the agent list
ns-squirrel agent list {filters} {page} {size} {sorts} {all_workspaces}
Copied!
Ask
Dispatches a message to the best available Squirrel agent and long-polls for the result.
ns-squirrel agent ask
Copied!
--model (String)
--message_system (String)
--message_history (Array)
--message_user (String)
Schemas
Agent
{ "name": "Agent", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "email": { "type": "String", "required": true, "max": 255 }, "phone": { "type": "String", "required": true, "max": 255 }, "last_online_at": { "type": "DateTime", "required": false }, "last_offline_at": { "type": "DateTime", "required": false }, "last_seen_at": { "type": "DateTime", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
AskMessage
{ "name": "AskMessage", "type": "Object", "required": false, "fields": { "role": { "type": "String", "required": true }, "content": { "type": "String", "required": true } }}
AskOutput
{ "name": "AskOutput", "type": "Object", "required": true, "fields": { "request_id": { "type": "String", "required": true }, "chat_id": { "type": "String", "required": true }, "agent": { "name": "AskOutputAgent", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true }, "rid": { "type": "String", "required": true }, "provider": { "type": "String", "required": true }, "model": { "type": "String", "required": true }, "at_quota_limit": { "type": "Boolean", "required": true } } }, "successful": { "type": "String", "required": true }, "result": { "type": "String", "required": true }, "duration_ms": { "name": "AskOutputDuration", "type": "Object", "required": true, "fields": { "queue": { "type": "Integer", "required": true, "min": 0 }, "agent": { "type": "Integer", "required": true, "min": 0 }, "llm": { "type": "Integer", "required": true, "min": 0 }, "total": { "type": "Integer", "required": true, "min": 0 } } }, "tokens": { "name": "AskOutputTokens", "type": "Object", "required": true, "fields": { "input": { "type": "Integer", "required": true, "min": 0 }, "output": { "type": "Integer", "required": true, "min": 0 }, "total": { "type": "Integer", "required": true, "min": 0 } } }, "cost": { "name": "AskOutputCost", "type": "Object", "required": true, "fields": { "input": { "type": "Float", "required": true, "min": 0, "precision": 6 }, "output": { "type": "Float", "required": true, "min": 0, "precision": 6 }, "total": { "type": "Float", "required": true, "min": 0, "precision": 6 } } } }}
AskOutputAgent
{ "name": "AskOutputAgent", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true }, "rid": { "type": "String", "required": true }, "provider": { "type": "String", "required": true }, "model": { "type": "String", "required": true }, "at_quota_limit": { "type": "Boolean", "required": true } }}
AskOutputDuration
{ "name": "AskOutputDuration", "type": "Object", "required": true, "fields": { "queue": { "type": "Integer", "required": true, "min": 0 }, "agent": { "type": "Integer", "required": true, "min": 0 }, "llm": { "type": "Integer", "required": true, "min": 0 }, "total": { "type": "Integer", "required": true, "min": 0 } }}
AskOutputTokens
{ "name": "AskOutputTokens", "type": "Object", "required": true, "fields": { "input": { "type": "Integer", "required": true, "min": 0 }, "output": { "type": "Integer", "required": true, "min": 0 }, "total": { "type": "Integer", "required": true, "min": 0 } }}
AskOutputCost
{ "name": "AskOutputCost", "type": "Object", "required": true, "fields": { "input": { "type": "Float", "required": true, "min": 0, "precision": 6 }, "output": { "type": "Float", "required": true, "min": 0, "precision": 6 }, "total": { "type": "Float", "required": true, "min": 0, "precision": 6 } }}
Enums
Namira Software Corporation
©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.