Overview
The nuwacom API gives you programmatic access to your workspace: run AI completions with leading models, manage agents, and work with your knowledge base. Whether you are building custom applications, automating workflows, or enhancing existing systems, the API provides the building blocks you need.Available APIs
Completion API
Run AI completions through an OpenAI-compatible interface. Use plain models, enable knowledge base search and web search, or chat with a configured agent.- OpenAI Chat Completion: OpenAI-compatible chat completions, including agent support via the
agentIdoption
Agents API
Create and manage agents programmatically, with specialized instructions, conversation starters, and model options.- Agents API Overview: Complete guide to working with agents
- List agents, Create, Get, Update, Delete
Assets API
Manage documents in your knowledge base for retrieval-augmented generation.AI Models
Discover which models are available in your workspace and spaces. Use these model IDs in completion requests and agent options.Getting started
Base URL
Every nuwacom instance runs on its own tenant domain. Use your workspace’s tenant name for all API requests:Authentication
All API requests require authentication using a Bearer token:Keep your API key in a secure backend environment. Never expose it in client-side code such as JavaScript running in a web page.
Spaces
Most resources (agents, assets, conversations) belong to a space. The corresponding requests take the space ID, either in the URL path (e.g./api/v1/spaces/{spaceId}/agents) or as a space_id parameter, and the caller’s role in that space determines what they are allowed to do.
OpenAPI specification
A comprehensive OpenAPI specification for your instance is available athttps://{customer-tenant}.nuwacom.ai/api/openapi.json
We provide two convenient interfaces to explore the OpenAPI documentation:
- Scalar:
https://{customer-tenant}.nuwacom.ai/api/scalar - Swagger UI:
https://{customer-tenant}.nuwacom.ai/api/swagger