Skip to content

Welcome to the IA-2024B API Documentation

This documentation provides an overview and detailed information about the Testing API, which offers a Large Language Model (LLM) assistant on AGMRI. The API is designed to manage chat messages and includes various endpoints for submitting, deleting, and retrieving chat messages.

Getting Started

  • Use the menu on the left to navigate through the documentation.
  • Refer to the API Reference section for detailed information on each endpoint.
  • Check out the Quick Start Guide for a step-by-step tutorial on integrating the API.

First Time Using the Agent?

If you're new to our agent system, we recommend starting with the Agent Tutorial to familiarize yourself with its core concepts and functionalities.

Explore the documentation to understand how to effectively use the IA-2024B API.

Overview

The IA-2024B project offers a robust API for LLM services. This API facilitates efficient management of chat messages with endpoints for submitting, deleting, and retrieving messages. It provides a textual assistant to help users utilize AGMRI and retrieve information from the system.

Features

  • Create a Chat Session: Send chat messages for processing.
  • Continue a Chat: Send additional messages to an existing chat session.
  • Delete a Chat: Remove messages from the system.
  • Retrieve a Chat: Access all previously sent messages.
  • Retrieve Chat History: Retrieve chat history for a specific chat session.
  • Real-time Processing: Experience minimal latency with real-time message processing.
  • Scalability: Handle a large volume of chat messages efficiently.

Note

Please note that the AI agent currently retrieves data only from the current growing season. For example, if you're looking for planting dates from last year, such as the planting date for a specific field on March 15, 2023, this information will not be accessible due to a database endpoint issue. Historical data is not available at this time. Thank you for your understanding as we work on enhancements.

Important

Feature availability may vary in AGMRI. Please contact IntelinAir for detailed information about specific features and access rights.

Export HTML Chart Files

To provide a better user experience, the API will return an HTML Chart file that can be used to visualize the data. The HTML file will be returned in plain text format.

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of an API request. Common status codes include:

  • 200 OK: The request was successful.
  • 400 Bad Request: The request was invalid or cannot be served.
  • 401 Unauthorized: Authentication failed or user does not have permissions.
  • 404 Not Found: The requested resource could not be found.
  • 500 Internal Server Error: An error occurred on the server.

Stay Connected

For updates and support, contact us at support@algo-rythmn.io.