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.
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.
Chat and agents
Chats and messages including responses and ratings, agents (called assistants in the API) and their behavior, reusable prompts and templates.
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 API
HTTP endpoints with JSON, described in an OpenAPI specification, callable from any language.
Python SDK
Typed requests and responses for Python 3.13 and later.
Node SDK
The same client for Node.js 18 and later, with TypeScript types.
Always matches the version
The 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 keys
X-API-KEY header
Your application sends the key with every request. Admins create it in the settings under API Keys, or via the API.
Lifecycle
Revocable
The 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-in
Tokens and SSO
Besides keys: sign-in through the auth endpoints with bearer tokens, SSO and OAuth connections to external services.
Apps in neuland.ai HUB
Service token
AI 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.
Connecting something to neuland.ai HUB?
Let's talk it through.
Tell us briefly what you want to connect or build on it.
<p dir="auto">After your request</p>
01
You briefly describe your project
02
We show you the right endpoints and SDK methods
03
Your admins create the API key in neuland.ai HUB