Kumru LLM API

🔐 Authentication

All requests require the following HTTP header:

x-api-key: YOUR_API_KEY

Replace YOUR_API_KEY with the key you received after subscribing on AWS Marketplace.

Endpoint

POST /generate

Generates a model response using your prompt and parameters.

🔧 Query Parameters

• inputs (string, required): This is the prompt you want to process.
• parameters (string, optional): A JSON-formatted string that defines generation behavior such as token limits. By default, this is {"max_new_tokens": 100}.

📦 Example Request

curl -X POST '<https://api.kumru.ai/generate?inputs=What%20is%20Deep%20Learning&parameters=%7B%22max_new_tokens%22%3A%20300%7D>' \ -H 'accept: application/json' \ -H 'x-api-key: YOUR_API_KEY'

📦 Example Request (Python)

import requests url = "<https://api.kumru.ai/generate>" params = { "inputs": "What is Deep Learning", "parameters": '{"max_new_tokens": 250}' } headers = { "x-api-key": "YOUR_API_KEY" } response = requests.post(url, params=params, headers=headers, stream=True) print(response.json())

🔄 Response

[{"generated_text":"What is Deep Learning?\nDeep learning is a type of artificial intelligence that uses neural networks to process large amounts of data and learn patterns. It’s based on the idea that complex patterns and relationships can be learned and applied from scratch, rather than from existing data.\nDeep learning algorithms are designed to detect, classify, and make predictions about different types of data, such as images, text, and video. These algorithms can then use their learned patterns to make more accurate predictions or decisions. Deep learning algorithms are typically used in various fields, including artificial intelligence, machine learning, medicine, finance, and more. They are becoming increasingly important in areas such as predictive analytics and customer service, as well as in fields such as cybersecurity and fraud detection.}]

---

💡 Example Usage Flow

1. Subscribe to Kumru LLM API on AWS Marketplace.
2. An API key is created and stored in Secrets Manager.
3. Use that API key to authenticate calls to /generate.

---

📛 Error Codes

Possible status codes returned by the API include:

• 403: Unauthorized – Your API key is missing or invalid.
• 400: Bad Request – The input parameters are malformed.
• 502: Backend Error – The TGI model server failed to process the request.
• 500: Internal Server Error – An unexpected issue occurred on the server.

❌ Example Error Response

{ "detail": "Unauthorized API key" }

---

📘 Learn More

• 🌐 VNGRS AI 
• 🛒 API docs