> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omnifact.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API-Übersicht & Authentifizierung

> Erfahren Sie, wie Sie sich authentifizieren und in die öffentliche API von Omnifact und veröffentlichte Space-Endpunkte integrieren

export const Glossary = ({children, term}) => {
  const glossaryDefinitions = {
    'ai': 'Künstliche Intelligenz - Computersysteme, die Aufgaben ausführen können, die normalerweise menschliche Intelligenz erfordern',
    'artificial-intelligence-ai': 'Computersysteme, die Aufgaben ausführen können, die normalerweise menschliche Intelligenz erfordern',
    'ai-assistant': 'Ein KI-System, das Benutzern durch Konversation bei Aufgaben hilft',
    'space': 'Eine dedizierte Umgebung mit einem spezialisierten KI-Assistenten und optionalen Hochgeladenen Dateien',
    'spaces': 'Dedizierte Umgebungen mit spezialisierten KI-Assistenten und optionalen Hochgeladenen Dateien',
    'knowledge': 'Das Untermenü in den Space-Einstellungen, in dem Sie Hochgeladene Dateien und Verbundene Quellen verwalten',
    'uploaded-files': 'Dokumente, die manuell unter dem Knowledge Tab in einen Space hochgeladen wurden',
    'prompt': 'Anweisungen oder Fragen, die Sie einem KI-Assistenten geben',
    'response': 'Die Antwort des KI-Assistenten auf Ihren Prompt oder Ihre Frage',
    'query': 'Eine Frage oder Anfrage nach Informationen',
    'context': 'Hintergrundinformationen, die der KI helfen, Ihre Anfrage zu verstehen',
    'llm': 'Large Language Model - ein KI-System, das mit großen Textmengen trainiert wurde, um menschliche Sprache zu verstehen und zu generieren',
    'large-language-model-llm': 'Ein KI-System, das mit großen Textmengen trainiert wurde, um menschliche Sprache zu verstehen und zu generieren',
    'privacy-filter': 'Ein System, das automatisch sensible Informationen erkennt und maskiert, bevor sie KI-Modelle erreichen, und Bilder daran hindert, an nicht-EU-gehostete Modelle gesendet zu werden, um Compliance zu gewährleisten',
    'chat-instructions': 'Benutzerdefinierte Richtlinien, die definieren, wie sich ein KI-Assistent in einem Space verhält und antwortet',
    'pattern-matching': 'Der Prozess, durch den KI Muster in Daten erkennt und verwendet, um Antworten zu liefern',
    'patterns': 'Erkennbare Strukturen oder Trends in Daten, die KI-Systeme identifizieren und verwenden können',
    'training-data': 'Der Text und die Informationen, die verwendet werden, um einem KI-System beizubringen, wie es Anfragen versteht und darauf antwortet',
    'natural-language': 'Alltägliche menschliche Sprache, die Menschen zur Kommunikation verwenden, im Gegensatz zu Computercode oder formaler Syntax',
    'hallucination': 'Wenn eine KI Informationen generiert, die plausibel klingen, aber tatsächlich falsch oder erfunden sind',
    'filtering': 'Der Prozess der automatischen Erkennung und temporären Ersetzung sensibler Informationen, um sie während der KI-Verarbeitung zu schützen',
    'masking': 'Temporäres Ersetzen sensibler Informationen durch generische Bezeichnungen, um sie vor externen KI-Modellen zu schützen',
    're-insertion': 'Der automatische Prozess, originale sensible Informationen wieder in KI-Antworten einzufügen, nachdem sie mit gefilterten Daten generiert wurden',
    'retrieval': 'Der Prozess des Findens und Zugreifens auf relevante Dokumente aus Hochgeladenen Dateien, um Fragen zu beantworten',
    'hosting': 'Wo ein KI-Modell bereitgestellt und zur Nutzung verfügbar gemacht wird - entweder von Drittanbietern, auf den eigenen Servern Ihrer Organisation oder in privaten Cloud-Umgebungen',
    'cite': 'Eine Quelle referenzieren oder erwähnen, um zu zeigen, woher die Antwort einer KI stammt',
    'sidebar': 'Ein Panel, das auf der Seite des Bildschirms erscheint und zusätzliche Informationen und Optionen anzeigt',
    'toggle': 'Ein Button oder eine Steuerung, die etwas ein- oder ausschaltet, wie das Öffnen und Schließen einer Sidebar',
    'navigation': 'Das System von Menüs und Buttons, das Ihnen hilft, zwischen verschiedenen Teilen von Omnifact zu navigieren',
    'favoriting': 'Ein Space als Favorit markieren, um es in der Hauptnavigation zu fixieren für schnellen Zugriff',
    'pinning': 'Ein Space an die Hauptnavigationsleiste anheften, damit es immer sichtbar und leicht zugänglich ist'
  };
  const definition = glossaryDefinitions[term];
  return <Tooltip tip={definition}>{children}</Tooltip>;
};

Die öffentliche API von Omnifact ermöglicht es Entwicklern und Teams, die KI-Funktionen von Omnifact in externe Anwendungen, benutzerdefinierte Portale und automatisierte Workflows zu integrieren. Sie können Dokumente in den Hochgeladenen Dateien eines Space verwalten, den Systemstatus abfragen und direkt mit veröffentlichten <Glossary term="space">Spaces</Glossary> kommunizieren.

<Card title="Interaktive OpenAPI-Dokumentation" icon="code" href="https://connect.omnifact.ai/docs" target="_blank" horizontal>
  Greifen Sie unter connect.omnifact.ai/docs auf die interaktive Swagger / OpenAPI-Spezifikation für Live-Endpunkttests und vollständige Schemadefinitionen zu.
</Card>

## Authentifizierung

Alle Anfragen an die öffentliche API von Omnifact erfordern eine Authentifizierung über einen API-Schlüssel, der im HTTP-Header `X-API-Key` übergeben wird.

```http theme={null}
X-API-Key: ihr_omnifact_api_schluessel_hier
```

<Note>
  Bewahren Sie Ihren API-Schlüssel sicher auf. Geben Sie Ihren API-Schlüssel nicht in clientseitigem Code, öffentlichen Repositories oder Frontend-Webanwendungen preis.
</Note>

### API-Schlüssel verwalten

Team-Administratoren können Organisations-API-Schlüssel direkt aus der Omnifact-Anwendung heraus generieren und verwalten:

1. Navigieren Sie in der Hauptnavigationsleiste zu den **Teameinstellungen**.
2. Klicken Sie auf **Entwickler-Tools** (erfordert Administratorrechte).
3. Aktivieren Sie den **API-Zugriff**, falls er nicht bereits aktiv ist.
4. Klicken Sie auf **API-Schlüssel generieren**, um einen Schlüssel für Ihr Team zu erstellen.

Schritt-für-Schritt-Anleitungen zum Aktivieren des Entwicklerzugriffs finden Sie unter [Entwickler-Tools](/de/platform/team-administration/developer-tools).

## Basis-URL

Alle Anfragen an die öffentliche API sollten an die folgende Basis-URL gesendet werden:

```http theme={null}
https://connect.omnifact.ai
```

## Verfügbare API-Ressourcen

Die öffentliche API ist in zwei primäre Funktionsbereiche unterteilt:

<CardGroup cols={2}>
  <Card title="Dokumente-API" icon="folder-tree" href="/de/api-reference/documents">
    Dokumente in den Hochgeladenen Dateien eines Space programmgesteuert auflisten, hochladen, prüfen, umbenennen und löschen.
  </Card>

  <Card title="Veröffentlichte Spaces Chat-API" icon="comments" href="/de/api-reference/published-space-chat">
    Nachrichten an veröffentlichte Space-Endpunkte senden, mit Unterstützung für JSON und Echtzeit-SSE-Streaming.
  </Card>
</CardGroup>

## Fehlerbehandlung

Die API verwendet standardmäßige HTTP-Statuscodes zur Anzeige von Anfrageresultaten:

| Statuscode              | Bedeutung                | Beschreibung                                                          |
| :---------------------- | :----------------------- | :-------------------------------------------------------------------- |
| `200 OK`                | Erfolg                   | Anfrage erfolgreich.                                                  |
| `201 Created`           | Erstellt                 | Ressource erfolgreich erstellt (z. B. Dokument-Upload).               |
| `400 Bad Request`       | Ungültige Anfrage        | Fehlende oder ungültige Parameter.                                    |
| `401 Unauthorized`      | Nicht autorisiert        | Fehlender oder ungültiger `X-API-Key`-Header.                         |
| `404 Not Found`         | Nicht gefunden           | Angefordertes Dokument oder Endpunkt-ID existiert nicht.              |
| `429 Too Many Requests` | Ratenlimit überschritten | Kontingent oder Ratenlimit überschritten.                             |
| `500 Internal Error`    | Serverfehler             | Bei der Verarbeitung der Anfrage ist ein interner Fehler aufgetreten. |

Alle Fehlerantworten geben ein JSON-Objekt mit Fehlerdetails zurück:

```json theme={null}
{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Der angegebene Header X-API-Key ist ungültig oder abgelaufen."
  }
}
```

## Nächste Schritte

* Erkunden Sie die [Dokumente-API](/de/api-reference/documents) für die Dokumentenverwaltung
* Erfahren Sie, wie Sie Chat-Antworten mit der [Veröffentlichten Spaces Chat-API](/de/api-reference/published-space-chat) streamen
* Konfigurieren Sie API-Einstellungen unter [Entwickler-Tools](/de/platform/team-administration/developer-tools)
