@intentkit/nation-sdk
v0.1.16
Published
OpenAPI client for @intentkit/nation-sdk
Readme
@intentkit/[email protected]
This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run buildPublishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @intentkit/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AgentApi | createAgent | POST /agents | Create a new agent AgentApi | getAgentById | GET /agents/{aid} | Get agent by ID AgentApi | getAgentStatistics | GET /agents/{aid}/statistics | Get Agent Statistics ChatApi | createChatThread | POST /agents/{aid}/chats | Create a new chat thread ChatApi | deleteChatThread | DELETE /agents/{aid}/chats/{chat_id} | Delete a chat thread ChatApi | getChatThreadById | GET /agents/{aid}/chats/{chat_id} | Get chat thread by ID ChatApi | getMessageById | GET /messages/{message_id} | Get message by ID ChatApi | listChatsForAgent | GET /agents/{aid}/chats | List chat threads for an agent ChatApi | listMessagesInChat | GET /agents/{aid}/chats/{chat_id}/messages | List messages in a chat thread ChatApi | retryMessageInChat | POST /agents/{aid}/chats/{chat_id}/messages/retry | Retry a message in a chat thread ChatApi | sendMessageToChat | POST /agents/{aid}/chats/{chat_id}/messages | Send a message to a chat thread ChatApi | updateChatThread | PATCH /agents/{aid}/chats/{chat_id} | Update a chat thread CreditApi | fetchCreditEvent | GET /credit/events/{event_id} | Credit Event CreditApi | getUserAccount | GET /credit/user/account | Get User Account CreditApi | listAgentIncomeEvents | GET /credit/agents/{agent_id}/events | List Agent Income CreditApi | listUserEvents | GET /credit/user/events | List User Events CreditApi | listUserTransactions | GET /credit/user/transactions | List User Transactions HealthApi | healthCheckHealthGet | GET /health | Health check endpoint MetadataApi | getLlmsMetadataLlmsGet | GET /metadata/llms | Get all LLM models MetadataApi | getSkillsMetadataSkillsGet | GET /metadata/skills | Get all skills
Documentation For Models
- AgentAutonomous
- AgentExample
- AgentResponse
- AgentStatisticsResponse
- AgentUpdate
- AuthorType
- Chat
- ChatMessage
- ChatMessageAttachment
- ChatMessageAttachmentType
- ChatMessageRequest
- ChatMessageSkillCall
- ChatMessagesResponse
- ChatUpdateRequest
- CreditAccount
- CreditDebit
- CreditEvent
- CreditEventWithAgent
- CreditEventsResponse
- CreditTransactionResp
- CreditTransactionsResponse
- CreditType
- Direction
- EventType
- FeePercentage
- HTTPValidationError
- LLMModelInfoWithProviderName
- LLMProvider
- OwnerType
- Skill
- TransactionType
- UpstreamType
- ValidationError
- ValidationErrorLocInner
Documentation For Authorization
Authentication schemes defined for the API:
HTTPBearer
- Type: Bearer authentication
