Chat and agents
Chats and messages including responses and ratings, agents (called assistants in the API) and their behavior, reusable prompts and templates.
SDK and API documentation
One API for all of neuland.ai HUB. With SDKs for Python and Node.
Chat, document queries, agents, integrations and the administration behind them: all through one REST API with an OpenAPI specification, plus typed clients for your own applications.
Example · REST API, create an API key
What the API covers
What you control via the API. The whole platform, not just the chat.
Endpoints are grouped by resource and described in an OpenAPI specification. For every endpoint, the reference shows parameters and schemas and lets you try it out directly.
Documents and knowledge queries
Upload, index and organize documents in libraries, run retrieval queries across your content, transcribe audio.
Tools and actions
Tools that agents call, and the execution of individual actions, such as sending an email.
Data sources
Search and connect data sources such as SharePoint, OneDrive, Nextcloud, Confluence or Jira; per-user OAuth connections to external services.
Users, tenants and projects
Accounts and profiles, invitations, tenants with branding and memberships, projects that bundle chats and documents.
Models and usage
Model catalog, model settings per tenant, token usage and costs, budget alerts and plans.
REST API and SDKs
Plain HTTP or SDK. The endpoints stay the same.
The illustration shows an example call with the Node SDK.
Call the REST API from any language. If you prefer working with types, use the generated SDKs: each resource becomes a client class, each endpoint a method.
- REST APIHTTP endpoints with JSON, described in an OpenAPI specification, callable from any language.
- Python SDKTyped requests and responses for Python 3.13 and later.
- Node SDKThe same client for Node.js 18 and later, with TypeScript types.
- Always matches the versionThe SDK method reference is generated directly from the package with every release.
Authentication
How your applications sign in. With an API key, token or service token.
Your admins control access. Keys are created in neuland.ai HUB or via the API and can be revoked at any time.
API keysX-API-KEY headerYour application sends the key with every request. Admins create it in the settings under API Keys, or via the API.
LifecycleRevocableThe full key is shown only once, at creation. To rotate or block it, you revoke it and create a new one; an expiry date is optional.
Sign-inTokens and SSOBesides keys: sign-in through the auth endpoints with bearer tokens, SSO and OAuth connections to external services.
Apps in neuland.ai HUBService tokenAI applications that run in neuland.ai HUB need no key of their own: neuland.ai HUB passes them a signed token (JWT) at startup.
FAQ
Questions about access, SDKs and authentication.
After a short request, you get access to the documentation with the API reference and SDK methods.
Python 3.13 and later, and Node.js 18 and later with TypeScript types. From any other language, you call the REST API directly over HTTP.
Your admins, in the settings under API Keys or via the API. The full key is shown only once and can be revoked at any time.
No. neuland.ai HUB passes them a signed service token (JWT) at startup.
Including chat and agents, documents and knowledge queries, tools and actions, data sources, users, tenants and projects, and models and usage.
Yes. The endpoints are described in an OpenAPI specification; for every endpoint, the reference shows parameters and schemas and lets you try it out directly.
The SDK method reference is generated directly from the package with every release.
Through the auth endpoints with bearer tokens, via SSO and through OAuth connections to external services.
Connecting something to neuland.ai HUB? Let's talk it through.
Tell us briefly what you want to connect or build on it.
After your request
- 01You briefly describe your project
- 02We show you the right endpoints and SDK methods
- 03Your admins create the API key in neuland.ai HUB