# AIVAX
AI model inference, document indexing and search.

Helpful links:
- API endpoint: https://inference.aivax.net/
- Reference for agents: https://inference.aivax.net/apidocs/llms.txt
- Documentation/guides: https://docs.aivax.net/
- Terms of service: https://docs.aivax.net/docs/en/legal/terms-of-service
- Privacy Policy: https://docs.aivax.net/docs/en/legal/privacy-policy

API Version: 1

## Inference
- [Model listing](http://inference.aivax.net/apidocs/llms.txt?endpoint=Modellisting): Lists the available AI models and AI gateways for the authenticated account.
- [Inference (chat completions)](http://inference.aivax.net/apidocs/llms.txt?endpoint=Inferencechatcompletions): Creates a chat completion response using the specified AI model.

## Hook Schedules
- [Get Schedule](http://inference.aivax.net/apidocs/llms.txt?endpoint=GetSchedule): Returns full details of a specific hook activation schedule.
- [Cancel Schedule](http://inference.aivax.net/apidocs/llms.txt?endpoint=CancelSchedule): Cancels and removes a pending hook activation schedule.
- [Get Recurring Task](http://inference.aivax.net/apidocs/llms.txt?endpoint=GetRecurringTask): Returns full details of a specific hook activation recurring task.
- [Cancel Recurring Task](http://inference.aivax.net/apidocs/llms.txt?endpoint=CancelRecurringTask): Cancels and removes a hook activation recurring task.
- [List Hook Schedules](http://inference.aivax.net/apidocs/llms.txt?endpoint=ListHookSchedules): Lists hook activation schedules and recurring tasks for a web chat client. Optionally filter by exte...

## Web Chat
- [Delete Web Chat Client Integration](http://inference.aivax.net/apidocs/llms.txt?endpoint=DeleteWebChatClientIntegration): Deletes a specific integration from a web chat client
- [Edit Web Chat Client Integrations](http://inference.aivax.net/apidocs/llms.txt?endpoint=EditWebChatClientIntegrations): Updates integrations for a web chat client
- [View Web Chat Client](http://inference.aivax.net/apidocs/llms.txt?endpoint=ViewWebChatClient): Gets details of a specific web chat client
- [Edit Web Chat Client](http://inference.aivax.net/apidocs/llms.txt?endpoint=EditWebChatClient): Updates an existing web chat client
- [Delete Web Chat Client](http://inference.aivax.net/apidocs/llms.txt?endpoint=DeleteWebChatClient): Deletes a web chat client
- [List Web Chat Clients](http://inference.aivax.net/apidocs/llms.txt?endpoint=ListWebChatClients): Lists all web chat clients for the authenticated account
- [Create Web Chat Client](http://inference.aivax.net/apidocs/llms.txt?endpoint=CreateWebChatClient): Creates a new web chat client

## Web Chat Sessions
- [Delete Web Chat Session](http://inference.aivax.net/apidocs/llms.txt?endpoint=DeleteWebChatSession): Deletes a web chat session
- [Create Web Chat Session](http://inference.aivax.net/apidocs/llms.txt?endpoint=CreateWebChatSession): Creates a new session for a web chat client
- [List Web Chat Sessions](http://inference.aivax.net/apidocs/llms.txt?endpoint=ListWebChatSessions): Lists sessions for a web chat client

## RAG
- [Semantic search](http://inference.aivax.net/apidocs/llms.txt?endpoint=Semanticsearch): Queries a collection for documents matching the specified term.

## Web Chat Client
- [Download Session Transcript](http://inference.aivax.net/apidocs/llms.txt?endpoint=DownloadSessionTranscript): Downloads the session messages, context, and metadata as a JSON file.
- [Retry Last Message](http://inference.aivax.net/apidocs/llms.txt?endpoint=RetryLastMessage): Removes all messages after the last user message, allowing the user to retry the conversation from t...
- [Send Prompt](http://inference.aivax.net/apidocs/llms.txt?endpoint=SendPrompt): Sends a prompt to the AI gateway and returns the completion result synchronously.
- [Get Session Info](http://inference.aivax.net/apidocs/llms.txt?endpoint=GetSessionInfo): Retrieves information about the current session, including messages, client configuration, and cultu...
- [Cancel Inference](http://inference.aivax.net/apidocs/llms.txt?endpoint=CancelInference): Cancels an ongoing inference operation for the current session.

## Memories
- [Get Memory](http://inference.aivax.net/apidocs/llms.txt?endpoint=GetMemory): Retrieves the details of a specific persisted memory.
- [List Memories](http://inference.aivax.net/apidocs/llms.txt?endpoint=ListMemories): Lists persisted memories for the authenticated account.
- [Delete Memories](http://inference.aivax.net/apidocs/llms.txt?endpoint=DeleteMemories): Deletes persisted memories by id or by external user id.

## Collections
- [Update Collection Vectors](http://inference.aivax.net/apidocs/llms.txt?endpoint=UpdateCollectionVectors): Resets vectors for all documents in a collection, triggering re-indexing
- [Reset Collection](http://inference.aivax.net/apidocs/llms.txt?endpoint=ResetCollection): Clears all documents from a collection
- [Export Collection](http://inference.aivax.net/apidocs/llms.txt?endpoint=ExportCollection): Exports the collection documents in JSONL format
- [Edit Collection](http://inference.aivax.net/apidocs/llms.txt?endpoint=EditCollection): Updates a collection's name
- [Get Collection Details](http://inference.aivax.net/apidocs/llms.txt?endpoint=GetCollectionDetails): Gets details about a specific collection
- [Delete Collection](http://inference.aivax.net/apidocs/llms.txt?endpoint=DeleteCollection): Deletes a collection
- [List Collections](http://inference.aivax.net/apidocs/llms.txt?endpoint=ListCollections): Lists all collections for the authenticated account
- [Create Collection](http://inference.aivax.net/apidocs/llms.txt?endpoint=CreateCollection): Creates a new collection

## Documents
- [Get Document](http://inference.aivax.net/apidocs/llms.txt?endpoint=GetDocument): Gets details of a specific document
- [Delete Document](http://inference.aivax.net/apidocs/llms.txt?endpoint=DeleteDocument): Deletes a document
- [Browse Documents](http://inference.aivax.net/apidocs/llms.txt?endpoint=BrowseDocuments): Lists documents in a collection with filtering and sorting
- [Index Documents (JSONL)](http://inference.aivax.net/apidocs/llms.txt?endpoint=IndexDocumentsJSONL): Uploads and indexes documents from a JSONL file
- [Create or Update Document](http://inference.aivax.net/apidocs/llms.txt?endpoint=CreateorUpdateDocument): Creates or updates a single document

## AI Gateways
- [EditGateway](http://inference.aivax.net/apidocs/llms.txt?endpoint=EditGateway): Edits an existing AI gateway.
- [ViewAiGateway](http://inference.aivax.net/apidocs/llms.txt?endpoint=ViewAiGateway): Retrieves details of a specific AI gateway.
- [DeleteAiGateway](http://inference.aivax.net/apidocs/llms.txt?endpoint=DeleteAiGateway): Deletes a specific AI gateway.
- [CreateGateway](http://inference.aivax.net/apidocs/llms.txt?endpoint=CreateGateway): Creates a new AI gateway under the logged-in account.
- [ListAiGateways](http://inference.aivax.net/apidocs/llms.txt?endpoint=ListAiGateways): Lists all AI gateways associated with the logged-in account.

## Accounts
- [Roll Salt](http://inference.aivax.net/apidocs/llms.txt?endpoint=RollSalt): Generates a new random salt for the account, invalidating webhooks and integrations that depend on t...
- [Update Account](http://inference.aivax.net/apidocs/llms.txt?endpoint=UpdateAccount): Updates the name and parameters of the authenticated account.

## API Keys
- [Delete API Key](http://inference.aivax.net/apidocs/llms.txt?endpoint=DeleteAPIKey): Removes an existing API key from the authenticated account.
- [List API Keys](http://inference.aivax.net/apidocs/llms.txt?endpoint=ListAPIKeys): Returns all API keys for the authenticated account along with the current salt.
- [Create API Key](http://inference.aivax.net/apidocs/llms.txt?endpoint=CreateAPIKey): Creates a new API key for the authenticated account.