# nuwacom Documentation ## Using nuwacom ### Introduction - [Getting started](https://docs.nuwacom.ai/en/product/gettingstarted.md) - [Advanced](https://docs.nuwacom.ai/en/product/advanced.md) ### Product - [Notetaker](https://docs.nuwacom.ai/en/product/notetaker.md) - [Knowledge](https://docs.nuwacom.ai/en/product/knowledge.md) - [Apps](https://docs.nuwacom.ai/en/product/apps.md) - [Workflows](https://docs.nuwacom.ai/en/product/workflows.md) - [Prompts](https://docs.nuwacom.ai/en/product/prompts.md): Discover, create, and manage prompts to enhance your chat experience and simplify daily tasks. - [Search](https://docs.nuwacom.ai/en/product/search.md): Quickly access information and generate content from your data - [Projects](https://docs.nuwacom.ai/en/product/projects.md): Organize your documents in projects, create multiple documents, and collaborate with your team. - [Release Notes](https://docs.nuwacom.ai/en/product/releasenotes.md) #### Chat - [Chat](https://docs.nuwacom.ai/product/chat.md): Interactive chat for creating content and answering questions - [Orchestrator](https://docs.nuwacom.ai/en/orchestrator.md) - [Documents](https://docs.nuwacom.ai/en/documents.md) - [Slides](https://docs.nuwacom.ai/en/slides.md) - [Images](https://docs.nuwacom.ai/en/images.md) - [Videos](https://docs.nuwacom.ai/en/videos.md) - [Research](https://docs.nuwacom.ai/en/research.md) - [Data Analysis](https://docs.nuwacom.ai/en/data-analysis.md) - [Emails](https://docs.nuwacom.ai/en/emails.md) - [Search](https://docs.nuwacom.ai/en/enterprise-search.md): Quickly access information and generate content from your data ### Skills - [Introduction to Skills](https://docs.nuwacom.ai/en/introduction-to-skills.md) - [Creating Skills](https://docs.nuwacom.ai/en/creating-skills.md) - [Manage Skills](https://docs.nuwacom.ai/en/manage-skills.md) - [Advanced Features](https://docs.nuwacom.ai/advanced-features.md) - [Skills in Agents](https://docs.nuwacom.ai/skills-in-agents.md) - [Skill Templates](https://docs.nuwacom.ai/en/skill-templates.md) ### Agents - [Introduction to Agents](https://docs.nuwacom.ai/en/introduction-to-agents.md) - [Agent Builder](https://docs.nuwacom.ai/en/agent-builder.md) - [Agent Configuration](https://docs.nuwacom.ai/en/agent-configuration.md) - [Agent Advanced Features](https://docs.nuwacom.ai/en/agent-advanced-features.md) - [Agent Templates](https://docs.nuwacom.ai/en/agent-templates.md) - [Agent Analytics](https://docs.nuwacom.ai/en/agent-analytics.md) ### Connectors - [Introduction to Connectors](https://docs.nuwacom.ai/en/product/connectors.md) - [Connections](https://docs.nuwacom.ai/en/connections.md) - [Connector Directory](https://docs.nuwacom.ai/en/connector-directory.md) #### MCP - [MCP Directory](https://docs.nuwacom.ai/en/mcp-directory.md) - [Connect an MCP Server](https://docs.nuwacom.ai/en/connect-mcp-server.md) ### Settings - [Account](https://docs.nuwacom.ai/en/account.md): In the account settings section, you can manage your profile and customize your individual preferences for using your nuwacom workspace. ## Admin ### Workspace - [Workspace settings](https://docs.nuwacom.ai/en/workspacesettings.md): Organize and manage your workspace - [User management](https://docs.nuwacom.ai/en/usermanagement.md): Invite users and manage their access rights on the platform - [SSO & User Sync](https://docs.nuwacom.ai/en/sso-and-usersync.md) - [Analytics](https://docs.nuwacom.ai/en/analytics.md) - [Privacy Mode](https://docs.nuwacom.ai/en/privacymode.md) ### Manage AI Usage - [Plans](https://docs.nuwacom.ai/en/plans.md) - [AI Usage](https://docs.nuwacom.ai/en/ai-usage.md) ### AI Adoption - [Rollout Setup ](https://docs.nuwacom.ai/en/aiadoption/rolloutsetup.md) - [Rollout Playbook](https://docs.nuwacom.ai/en/aiadoption/rolloutplaybook.md) - [Identifying Use Cases](https://docs.nuwacom.ai/en/aiadoption/identifyingusecases.md) ### Guides - [Glossary](https://docs.nuwacom.ai/en/glossary.md): Terms and definitions for a quick introduction to nuwacom - [Usage Rules](https://docs.nuwacom.ai/en/usage-rules.md) - [AI Models](https://docs.nuwacom.ai/en/aimodels.md): The latest and most advanced AI models—seamlessly integrated - [Policy Hierarchy](https://docs.nuwacom.ai/en/policy-hierarchy.md) ### Prompt Engineering - [How to write effective prompts](https://docs.nuwacom.ai/en/generateprompts.md): Guide to writing effective AI prompts ## Security - [Handling of personal and private data](https://docs.nuwacom.ai/en/handlingofpersonalandprivatedata.md) - [Measures](https://docs.nuwacom.ai/en/security/measures.md) ## API Reference ### Overview - [API Introduction](https://docs.nuwacom.ai/admin/api/introduction.md): Integrate nuwacom's AI capabilities and your knowledge base into your own applications ### AI - [List all AI models](https://docs.nuwacom.ai/api-reference/ai/list-all-ai-models.md): List all supported AI models - [List space AI models](https://docs.nuwacom.ai/api-reference/ai/list-space-ai-models.md): List all supported AI models for a specific space ### Assets - [Add an asset via URL](https://docs.nuwacom.ai/api-reference/assets/add-an-asset-via-url.md): Add an asset to the system by providing a URL to the asset - [Upload an asset](https://docs.nuwacom.ai/api-reference/assets/upload-an-asset.md): Upload an asset to the system - [Get an asset](https://docs.nuwacom.ai/api-reference/assets/get-an-asset.md): Return the complete asset record (name, MIME type, connector info, metadata, processing state, etc.) for the provided asset as long as the caller has read access to the space. - [Update an asset](https://docs.nuwacom.ai/api-reference/assets/update-an-asset.md): Update mutable asset metadata (name, connector assignment, metadata JSON, file path info, etc.) without re-uploading the file itself. - [Delete an asset](https://docs.nuwacom.ai/api-reference/assets/delete-an-asset.md): Permanently delete an asset from the given space. This removes the stored file and any derived embeddings for that asset. ### Completion API - [OpenAI Chat Completion](https://docs.nuwacom.ai/api-reference/completion-api/openai-chat-completion.md): Create a new AI completion. You can find the supported models using [List all AI models](/api-reference/ai/list-all-ai-models). ### Agents - [Agents API Overview](https://docs.nuwacom.ai/admin/api/agents-overview.md): Create, manage, and chat with agents in your nuwacom workspace programmatically - [List agents](https://docs.nuwacom.ai/api-reference/agents/list-agents.md): List the agents of a space, ordered by most recently updated first. Built-in nuwacom system agents are excluded — only agents created in the space (via this API or the app) are returned. Results are paginated via the `limit` and `offset` query parameters; the response wraps the agents in `data` alon… - [Create an agent](https://docs.nuwacom.ai/api-reference/agents/create-an-agent.md): Create a new agent in a space. The agent starts as an unpublished draft (`published: false`); publish it in the app to share it with the space. - [Get an agent](https://docs.nuwacom.ai/api-reference/agents/get-an-agent.md): Return a single agent. Built-in nuwacom system agents are not available through this endpoint (404). The returned fields reflect the draft state (the version this API edits); `published` tells whether a published version exists. - [Update an agent](https://docs.nuwacom.ai/api-reference/agents/update-an-agent.md): Update an agent. Changes are written to the draft; the published version stays untouched until the agent is re-published in the app (`hasUnpublishedChanges` flags the drift). Omitted fields keep their current value. - [Publish an agent](https://docs.nuwacom.ai/api-reference/agents/publish-an-agent.md): Make the draft the published version of the agent. Copies the draft settings (including actions and skills) over the published version, so the Completion API uses them by default. If the draft has `embedEnabled: true`, publishing also makes the external embed widget live; this requires a non-empty `… - [Unpublish an agent](https://docs.nuwacom.ai/api-reference/agents/unpublish-an-agent.md): Remove the published version of the agent; it reverts to a draft. The draft keeps all settings and can be re-published at any time. Published copies of actions and skills are removed along with the published version. Idempotent: unpublishing an unpublished agent is a no-op. - [Delete an agent](https://docs.nuwacom.ai/api-reference/agents/delete-an-agent.md): Permanently delete an agent, including its draft and published settings, actions and skills. ### Skills - [Skills API Overview](https://docs.nuwacom.ai/admin/api/skills-overview.md): Create and manage skills in your nuwacom workspace programmatically - [List skills](https://docs.nuwacom.ai/api-reference/skills/list-skills.md): List the skills of a space, ordered by most recently updated first. Results are paginated via the `limit` and `offset` query parameters; the response wraps the skills in `data` alongside `total`, `limit`, `offset`, and `hasMore`. Only user-created skills are returned; built-in nuwacom skills are not… - [Create a skill](https://docs.nuwacom.ai/api-reference/skills/create-a-skill.md): Create a new skill in a space. The `instructions` become the body of the skill's SKILL.md file (its frontmatter is generated from `name` and `description`). The skill is active immediately; attach it to agents via the Agents API or in the nuwacom app. - [Get a skill](https://docs.nuwacom.ai/api-reference/skills/get-a-skill.md): Return a single skill, including its `instructions` (the body of the skill's SKILL.md file). - [Update a skill](https://docs.nuwacom.ai/api-reference/skills/update-a-skill.md): Update a skill. Omitted fields keep their current value. When `instructions` is provided it fully replaces the body of the skill's SKILL.md file; name/description changes are also synced into the SKILL.md frontmatter. Built-in nuwacom skills cannot be updated. - [Delete a skill](https://docs.nuwacom.ai/api-reference/skills/delete-a-skill.md): Permanently delete a skill, including its SKILL.md and any other files. Agents that had the skill attached simply lose it. Built-in nuwacom skills cannot be deleted. - [Enable a skill](https://docs.nuwacom.ai/api-reference/skills/enable-a-skill.md): Enable a skill for the whole space, so the AI loads it whenever its description matches the task. Skills are enabled by default when created; use this to revert a [Disable](/api-reference/skills/disable-a-skill). A space can have at most 40 active skills — enabling beyond that returns 409. Individua… - [Disable a skill](https://docs.nuwacom.ai/api-reference/skills/disable-a-skill.md): Disable a skill for the whole space: the AI stops loading it for everyone (users can still re-enable it for themselves in the nuwacom app). The skill and its files stay untouched — use this instead of deleting when you want to switch a skill off temporarily. Re-activate it via [Enable a skill](/api-… - [List skill files](https://docs.nuwacom.ai/api-reference/skills/list-skill-files.md): List all files in the skill's folder, including its SKILL.md. Use the returned `path` values with [Get a skill file](/api-reference/skills/get-a-skill-file). - [Get a skill file](https://docs.nuwacom.ai/api-reference/skills/get-a-skill-file.md): Return the text content of a file in the skill's folder. Only text files can be read through this endpoint; binary assets (images, fonts) are not available via the API. - [Create or replace a skill file](https://docs.nuwacom.ai/api-reference/skills/create-or-replace-a-skill-file.md): Create a new text file in the skill's folder or fully replace an existing one. Parent folders are created implicitly by the path. Writing to `SKILL.md` replaces the whole file including its frontmatter; when the new frontmatter contains a valid `description`, the skill's metadata is synced to it. Pr… - [Delete a skill file](https://docs.nuwacom.ai/api-reference/skills/delete-a-skill-file.md): Delete a file from the skill's folder. `SKILL.md` cannot be deleted — every skill needs one; change it via [Update a skill](/api-reference/skills/update-a-skill) instead. ## OpenAPI Specs - [openapi](/openapi.yaml) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [German (84 pages)](https://docs.nuwacom.ai/_llms/de.txt): Documentation for German. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.