Platform

Industries

Services

Resources

Company

Pricing

From AI strategy to a running platform: we show you the way.

Talk to us

Log in

DE

EN

English

Platform

Industries

Services

Resources

Company

Pricing

From AI strategy to a running platform: we show you the way.

Talk to us

Log in

DE

EN

English

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.

How do we get access to the documentation?

After a short request, you get access to the documentation with the API reference and SDK methods.

How do we get access to the documentation?

After a short request, you get access to the documentation with the API reference and SDK methods.

Which languages do the SDKs support?

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.

Which languages do the SDKs support?

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.

Who creates the API keys?

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.

Who creates the API keys?

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.

Do apps in neuland.ai HUB need their own key?

No. neuland.ai HUB passes them a signed service token (JWT) at startup.

Do apps in neuland.ai HUB need their own key?

No. neuland.ai HUB passes them a signed service token (JWT) at startup.

Which areas does the API cover?

Including chat and agents, documents and knowledge queries, tools and actions, data sources, users, tenants and projects, and models and usage.

Which areas does the API cover?

Including chat and agents, documents and knowledge queries, tools and actions, data sources, users, tenants and projects, and models and usage.

Can we try out the API first?

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.

Can we try out the API first?

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.

How does the SDK reference stay in line with the version?

The SDK method reference is generated directly from the package with every release.

How does the SDK reference stay in line with the version?

The SDK method reference is generated directly from the package with every release.

How do applications sign in without an API key?

Through the auth endpoints with bearer tokens, via SSO and through OAuth connections to external services.

How do applications sign in without an API key?

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.

<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

neuland.ai

The AI management and orchestration platform from Cologne.

Developed in Cologne. Operated in the EU or in your data center.

Certifications and compliance: ISO 27001, ISO 9001, GDPR, EU AI Act, DORA, StBerG, and BRAO
WirtschaftsWoche Best of Technology 2026 seal, 2nd place in the Process Management category for neuland.ai

© 2026 neuland AI AG