⌨️Quick API overview — amber

This article summarizes the main API functionalities and points you to the full developer documentation at https://developers.ambersearch.de.

Key features

  • Authentication: API key (recommended) and OAuth 2.0 Authorization Code Grant for third‑party apps. Base URL: https://customerDomain.ambersearch.de/api/beta.

  • Search endpoints: Full‑text search and web search endpoints for querying your indexed content. Use GET /search and POST /websearch endpoints.

  • Document management: Retrieve document metadata, download documents, and upload files via GET/POST endpoints (e.g., GET document metadata, POST upload file).

  • OpenAI-like AI endpoints: List available models, retrieve model details, and create chat completions (POST /api/beta/amberai/chat/completions) including parameters for model, temperature, streaming, tools and messages. Example cURL and code snippets are available.

  • AmberSearch MCP server: Introduces server integrations and additional capabilities for advanced use (see docs).

Quick start

  1. Create an API key in the amber UI .

    https://helpcenter.ambersearch.de/en/help/articles/1136690-how-to-get-your-api-key

  2. Call the search endpoint: curl -X GET "https://customerDomain.ambersearch.de/api/beta/search?query=example" -H "Authorization: Bearer YOUR_API_KEY".

  3. For AI/chat usage, list models then call chat/completions with messages and model id.

Notes & limits

  • The API is in beta and under active development; endpoints may change.

  • Rate limits apply and are tied to your API key.

For complete details, examples, and up‑to‑date reference, read the full documentation at https://developers.ambersearch.de