API server#

Note

AI Navigator is in beta testing. This documentation is currently under construction.

The built-in API server enables you to run open-source large language models (LLMs) locally on your own machine. It facilitates direct interaction with your models through API calls, providing a powerful tool for testing and deploying models without the need for external cloud services. By hosting your own API server locally, you have full control over the model’s behavior and maintain the privacy and security of your data.

Understanding the API server#

The API server is the core component of AI Navigator that enables you to interact with your locally downloaded LLMs through API calls.

Server address#

Your local server address, often referred to as localhost or 127.0.0.1, is the default address for the API server. It is a loopback address, meaning any network communication sent to this address will stay within the same machine, keeping your data secure and private. This is common for developing applications.

If you are working in an office network and would like to make your server accessible to other devices within the same network, you can set the server address to your machine’s local IP address. These are typically private networks, meaning they’re not routable on the public internet.

Setting the server address to 0.0.0.0 configures it to accept connections on all network interfaces. This can expose your server to the public internet if your network is configured to allow external connections and route traffic from external sources to your server.

Server port#

The server port tells the built-in API server where to listen for incoming traffic (i.e. where to listen and pick up API requests).

For more information, see Cloudflare’s article on ports.

Viewing API server logs#

To view your server logs:

  1. Open AI Navigator.

  2. Select API Server from the left-hand navigation.

The server logs provide information for the following metrics:

  • System information - Provides information about your system’s hardware capabilities.

  • Build information - Provides information about the version of the API server you are using.

  • Chat template - Shows the sequence of messaging defined for the system.

  • Server listening - Displays the server address and port number being listened to.

  • Slot information - Displays the number of available slots for the server. Each slot is able to manage one user API request at a time.

  • Task information - Displays information such as time spent processing and responding to a request, the request task ID, and which slot fulfilled the task.

The API server records all incoming traffic for the currently running server and displays relevant information in the Server Logs.

Once the server is stopped, the log is saved to ~/Library/Logs/ai-navigator with a timestamped filename (for example <YYYY><MM><DD><HH><MM><SS>_api-server.log), so you can efficiently locate specific server logs if necessary.

On this page