# Nugen API Reference Docs

## Docs

- [Create Agent Endpoint](https://docs.nugen.in/api-reference/agents/create-agent-endpoint.md): Create a new AI agent with custom configuration.
- [Delete Agent Endpoint](https://docs.nugen.in/api-reference/agents/delete-agent-endpoint.md): Permanently delete an agent.
- [Get Agent](https://docs.nugen.in/api-reference/agents/get-agent.md): Retrieve detailed information about a specific agent.
- [Get Agent System Prompt](https://docs.nugen.in/api-reference/agents/get-agent-system-prompt.md): Retrieve the complete system prompt and configuration for an agent.
- [List Agents](https://docs.nugen.in/api-reference/agents/list-agents.md): Retrieve all agents owned by the user.
- [Run Agent](https://docs.nugen.in/api-reference/agents/run-agent.md): Execute an AI agent by name with a user message.
- [Update Agent Endpoint](https://docs.nugen.in/api-reference/agents/update-agent-endpoint.md): Update agent configuration settings.
- [Create Alignment](https://docs.nugen.in/api-reference/alignment-project/create-alignment.md): Create a new domain alignment workflow.
- [Delete Alignment](https://docs.nugen.in/api-reference/alignment-project/delete-alignment.md): Delete an alignment project permanently.
- [Get Alignment Data](https://docs.nugen.in/api-reference/alignment-project/get-alignment-data.md): Retrieve detailed information about a specific alignment project.
- [Get Alignment Status](https://docs.nugen.in/api-reference/alignment-project/get-alignment-status.md): Get the status of an alignment task that was created using create endpoint.
- [List Alignment Projects](https://docs.nugen.in/api-reference/alignment-project/list-alignment-projects.md): Retrieve all alignment projects for the authenticated user.
- [Chat](https://docs.nugen.in/api-reference/answer-engine/chat.md): Chat with an answer engine using RAG (Retrieval-Augmented Generation).
- [Create Answer Engine](https://docs.nugen.in/api-reference/answer-engine/create-answer-engine.md): Create a new Answer Engine and index the provided documents.
- [Delete Answer Engine](https://docs.nugen.in/api-reference/answer-engine/delete-answer-engine.md): Delete an answer engine by its ID.
- [Get Analytics](https://docs.nugen.in/api-reference/answer-engine/get-analytics.md): Retrieve usage analytics for an answer engine.
- [Get Answer Engine](https://docs.nugen.in/api-reference/answer-engine/get-answer-engine.md): Retrieve details and current status of a specific answer engine.
- [Get Thread History](https://docs.nugen.in/api-reference/answer-engine/get-thread-history.md): Retrieve the full conversation history for a specific thread.
- [List Answer Engines](https://docs.nugen.in/api-reference/answer-engine/list-answer-engines.md): List all answer engines.
- [Retrieve](https://docs.nugen.in/api-reference/answer-engine/retrieve.md): Retrieve relevant document chunks without generating an answer.
- [Update System Prompt](https://docs.nugen.in/api-reference/answer-engine/update-system-prompt.md): Update the system prompt for an answer engine.
- [Create Benchmark Task](https://docs.nugen.in/api-reference/benchmark/create-benchmark-task.md): Create a new benchmark generation task from documents.
- [Delete Benchmark](https://docs.nugen.in/api-reference/benchmark/delete-benchmark.md): Delete a benchmark permanently.
- [Get Benchmark Data](https://docs.nugen.in/api-reference/benchmark/get-benchmark-data.md): Retrieve complete benchmark data with all questions and answers.
- [Get Benchmark List](https://docs.nugen.in/api-reference/benchmark/get-benchmark-list.md): Retrieve all benchmarks for the user.
- [Get Benchmark Status](https://docs.nugen.in/api-reference/benchmark/get-benchmark-status.md): Get the status of a benchmark generation task.
- [Upload Benchmark File](https://docs.nugen.in/api-reference/benchmark/upload-benchmark-file.md): Upload a pre-prepared benchmark file with questions and answers.
- [Delete Document](https://docs.nugen.in/api-reference/documents/delete-document.md): Permanently delete a document.
- [Edit Category Name](https://docs.nugen.in/api-reference/documents/edit-category-name.md): Rename a category across all documents.
- [List Documents](https://docs.nugen.in/api-reference/documents/list-documents.md): Retrieve all documents and categories for the authenticated user.
- [Update Document Categories](https://docs.nugen.in/api-reference/documents/update-document-categories.md): Update the categories assigned to a document.
- [Upload Documents](https://docs.nugen.in/api-reference/documents/upload-documents.md): Upload multiple documents.
- [Upload Documents Status](https://docs.nugen.in/api-reference/documents/upload-documents-status.md): Check the upload status of a document task.
- [Create Evaluation](https://docs.nugen.in/api-reference/evaluations/create-evaluation.md): Create a new model evaluation using an existing benchmark.
- [Delete Evaluation](https://docs.nugen.in/api-reference/evaluations/delete-evaluation.md): Delete an evaluation permanently. This endpoint permanently removes an evaluation and all its associated data.
- [Download Evaluation Results](https://docs.nugen.in/api-reference/evaluations/download-evaluation-results.md): Download evaluation results as a JSON file.
- [Get Evaluation Results](https://docs.nugen.in/api-reference/evaluations/get-evaluation-results.md): Retrieve the complete results of a finished evaluation.
- [Get Evaluation Status](https://docs.nugen.in/api-reference/evaluations/get-evaluation-status.md): Get the current status and progress of an evaluation.
- [List User Evaluations](https://docs.nugen.in/api-reference/evaluations/list-user-evaluations.md): Retrieve all evaluations for the authenticated user.
- [Generate Chat Completions](https://docs.nugen.in/api-reference/inference/generate-chat-completions.md): Generate conversational responses with streaming support and multimodal capabilities.
- [Generate Completions](https://docs.nugen.in/api-reference/inference/generate-completions.md): Generate text completions with streaming support.
- [Generate Text Embeddings](https://docs.nugen.in/api-reference/inference/generate-text-embeddings.md): Generate dense vector embeddings for input text.
- [Rerank Documents](https://docs.nugen.in/api-reference/inference/rerank-documents.md): Rerank documents based on semantic relevance to a query.
- [Deploy Aligned Model](https://docs.nugen.in/api-reference/models/deploy-aligned-model.md): Deploy an aligned model for inference use.
- [Get Deployment Status](https://docs.nugen.in/api-reference/models/get-deployment-status.md): Check the deployment status of an aligned model.
- [Get Undeploy Status](https://docs.nugen.in/api-reference/models/get-undeploy-status.md): Check the un-deployment status of an aligned model.
- [List Aligned Models](https://docs.nugen.in/api-reference/models/list-aligned-models.md): Retrieve all domain-aligned models for the authenticated user.
- [List Base Models](https://docs.nugen.in/api-reference/models/list-base-models.md): Retrieve the list of available base models.
- [Undeploy Model](https://docs.nugen.in/api-reference/models/undeploy-model.md): Undeploy a deployed aligned model.

## OpenAPI Specs

- [openapi-public](https://api.dev-nugen.in/openapi-public.json)
- [nugen-openapi](https://api.dev-nugen.in/nugen-openapi.json)

## Optional

- [API Status](https://status.nugen.in)
- [Nugen Intelligence](https://nugen.in)