@crestal/[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 build

Publishing

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 @crestal/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AgentApi | createAgent | POST /agents | Create Agent AgentApi | exportAgent | GET /agents/{agent_id}/export | Export Agent AgentApi | getAgent | GET /agents/{agent_id} | Get Agent AgentApi | getAgentApiKey | GET /agents/{agent_id}/api-key | Get Agent API Key AgentApi | getAgentAssets | GET /agents/{agent_id}/assets | Get Agent Assets AgentApi | getAgentLinkedAccounts | GET /agents/{agent_id}/linked | Get Agent Linked Accounts AgentApi | getAgentStatistics | GET /agents/{aid}/statistics | Get Agent Statistics AgentApi | getAgents | GET /agents | Get Agents AgentApi | getSkillHistory | GET /agents/{aid}/skill/history | Skill History AgentApi | importAgent | PUT /agents/{agent_id}/import | Import Agent AgentApi | overrideAgent | PUT /agents/{agent_id} | Override Agent AgentApi | overrideAgentPublicInfo | PUT /agents/{agent_id}/public-info | Override Agent Public Information AgentApi | publishAgent | POST /agents/{agent_id}/publish | Publish Agent AgentApi | resetAgentApiKey | POST /agents/{agent_id}/api-key/reset | Reset Agent API Key AgentApi | unpublishAgent | POST /agents/{agent_id}/unpublish | Unpublish Agent AgentApi | validateAgentCreate | POST /agent/validate | Validate Agent Create AgentApi | validateAgentUpdate | POST /agents/{agent_id}/validate | Validate Agent Update ChatApi | clearChatThreadMemory | POST /agents/{aid}/chats/{chat_id}/clear | Clear chat thread short-term memory 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 | getSkillHistory | GET /agents/{aid}/skill/history | Skill History 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 | listMessagesInDraft | GET /agents/{aid}/draft/messages | List messages in an agent draft session 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 | sendMessageToDraft | POST /agents/{aid}/draft/messages | Send a message to an agent draft session 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 | listTopupRecords | GET /credit/topup/records | List Top-up Records CreditApi | listUserEvents | GET /credit/user/events | List User Events CreditApi | listUserTransactions | GET /credit/user/transactions | List User Transactions DraftApi | createAgentDraft | POST /agent/draft | Create Agent Draft DraftApi | deleteAgentDraft | DELETE /agent/drafts/{draft_id} | Delete Agent Draft DraftApi | deployAgentFromDraft | POST /agent/deploy | Deploy Agent From Draft DraftApi | getAgentDraftById | GET /agents/{agent_id}/drafts/{draft_id} | Get Agent Draft By Id DraftApi | getAgentDrafts | GET /agents/{agent_id}/drafts | Get Agent Drafts DraftApi | getAgentLatestDraft | GET /agents/{agent_id}/draft/latest | Get Agent Latest Draft DraftApi | getUserUnpublishedDrafts | GET /agent/drafts | Get User Unpublished Drafts DraftApi | updateAgentDraft | PUT /agents/{agent_id}/draft | Update Agent Draft HealthApi | healthCheck | GET /health | Health check endpoint ManagerApi | getManagerMessages | GET /agents/{aid}/manager/messages | Get manager chat messages ManagerApi | sendManagerMessage | POST /agents/{aid}/manager/messages | Chat with Agent Manager MetadataApi | getAgentPublicSchema | GET /metadata/agent/public.json | Get public agent schema MetadataApi | getAgentPublicStrictSchema | GET /metadata/agent/public-strict.json | Get strict public agent schema MetadataApi | getAgentSchema | GET /metadata/agent/schema.json | Get agent schema MetadataApi | getLlms | GET /metadata/llms | Get all LLM models MetadataApi | getMetadataTags | GET /metadata/tags | Get metadata tags MetadataApi | getSkillIcon | GET /metadata/skills/{skill}/{icon_name}.{ext} | Get skill icon MetadataApi | getSkillSchema | GET /metadata/skills/{skill}/schema.json | Get skill schema MetadataApi | getSkills | GET /metadata/skills | Get all skills OAuthApi | getTwitterAuthUrl | GET /oauth/twitter | Get Twitter Auth Url OAuthApi | twitterOauthCallback | GET /callback/auth/twitter | Twitter Oauth Callback OAuthApi | unlinkTwitter | PUT /oauth/twitter/unlink | Unlink Twitter Endpoint UserApi | getCurrentUser | GET /user | Get Current User UserApi | getUserAgentById | GET /user/agents/{agent_id} | Get User Agent By Id UserApi | getUserAgents | GET /user/agents | Get User Agents UserApi | uploadUserFile | POST /user/upload | Upload User File X402Api | chatByX402 | POST /x/{aid} | Chat by x402 X402Api | x402Topup | POST /x402/topup | Top up caps via x402

Documentation For Models

• Agent
• AgentApiKeyResponse
• AgentAssetsResponse
• AgentAutonomousInput
• AgentAutonomousOutput
• AgentAutonomousStatus
• AgentDeployRequest
• AgentDraft
• AgentExample
• AgentLinkedAccountsResponse
• AgentListResponse
• AgentPublicInfo
• AgentResponse
• AgentSortOption
• AgentState
• AgentStatistics
• AgentUpdate
• AgentUserInput
• AgentVisibility
• Asset
• AuthorType
• Chat
• ChatMessage
• ChatMessageAttachment
• ChatMessageAttachmentType
• ChatMessageRequest
• ChatMessageSkillCall
• ChatMessagesResponse
• ChatUpdateRequest
• CreditAccount
• CreditDebit
• CreditEvent
• CreditEventWithAgent
• CreditEventsResponse
• CreditTransactionResp
• CreditTransactionsResponse
• CreditType
• Direction
• EventType
• FeePercentage
• FileUploadResponse
• HTTPValidationError
• LLMModelInfoWithProviderName
• LLMProvider
• LocationInner
• ManagerMessageRequest
• OwnerType
• Skill
• SystemMessageType
• Tag
• TopupRecord
• TopupRecordsResponse
• TransactionType
• TwitterAuthResponse
• UpstreamType
• User
• UserAgentListResponse
• ValidationError
• X402TopupResponse

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

• Type: Bearer authentication