Veröffentlichte Spaces Chat-API

Veröffentlichte Spaces ermöglichen es Organisationsadministratoren, konfigurierte als eigenständige API-Endpunkte bereitzustellen. Externe Anwendungen, benutzerdefinierte interne Tools oder automatisierte Workflows können Chat-Nachrichten an einen veröffentlichten Space senden und KI-Assistenten-Antworten erhalten, die auf den Anweisungen, Modellen und Hochgeladenen Dateien des Space basieren.

Vor dem Aufruf eines Chat-Endpunkts für einen veröffentlichten Space muss ein Team-Administrator den Space unter Teameinstellungen > Veröffentlichte Spaces veröffentlichen. Erfahren Sie mehr unter Veröffentlichte Spaces.

Endpunkt

POST /v1/endpoints/{endpointId}/chat

Anfrage-Header

Header	Typ	Erforderlich	Beschreibung
`X-API-Key`	`string`	Erforderlich	Ihr Team-API-Schlüssel, der in den Entwickler-Tools generiert wurde.
`Content-Type`	`string`	Erforderlich	Muss `application/json` sein.
`omnifact-enable-inline-sources`	`string`	Optional	Auf `"true"` setzen, um die Inline-Quellenangabenformatierung in den Antworten des Assistenten zu aktivieren.
`omnifact-enable-agentic-workflow`	`string`	Optional	Auf `"true"` setzen, um agentenbasiertes Multi-Tool-Reasoning während der Antwortgenerierung zu erlauben.

Anfragenachricht (`application/json`)

{
  "messages": [
    {
      "role": "user",
      "content": "Wie lautet unsere Richtlinie für mobiles Arbeiten?"
    }
  ],
  "streaming": false
}

Feld	Typ	Erforderlich	Beschreibung
`messages`	`array`	Erforderlich	Array von Nachrichtenzuständen (`role`: `"user"` \| `"assistant"`, `content`: `string`).
`streaming`	`boolean`	Optional	Auf `true` für Server-Sent Events (SSE) Streaming setzen; `false` für Standard-JSON (Standard: `false`).

Antwortmodi

1. Standard-JSON-Antwort (`streaming: false`)

Wenn streaming auf false gesetzt ist (oder weggelassen wird), verarbeitet der Endpunkt die gesamte Unterhaltung und gibt ein einzelnes JSON-Objekt zurück.

Beispielanfrage

curl -X POST "https://connect.omnifact.ai/v1/endpoints/ep_abc123/chat" \
  -H "X-API-Key: ihr_omnifact_api_schluessel_hier" \
  -H "Content-Type: application/json" \
  -H "omnifact-enable-inline-sources: true" \
  -d '{
    "messages": [
      {
        "role": "user",
        "content": "Was sind unsere primären Unternehmenswerte?"
      }
    ],
    "streaming": false
  }'

JSON-Antwort (`200 OK`)

{
  "id": "msg_xyz789",
  "role": "assistant",
  "content": "Laut unserem Mitarbeiterhandbuch lauten unsere Unternehmenswerte Transparenz, Innovation und Datenschutz [1].",
  "references": [
    {
      "id": 1,
      "title": "Mitarbeiterhandbuch_2026.pdf",
      "documentId": "doc_98765"
    }
  ]
}

2. SSE-Streaming-Antwort (`streaming: true`)

Wenn streaming auf true gesetzt ist, streamt der Server die Antwort als Echtzeit-Server-Sent Events (SSE) unter Verwendung von Content-Type: text/event-stream.

SSE-Ereignistypen

Der Ereignis-Stream sendet typisierte SSE-Ereignisse, während die Antwortgenerierung voranschreitet:

Ereignisname	Beschreibung	Nutzdatenstruktur
`assistant_write`	Gestreamtes Textfragment der Assistentenantwort.	`{"delta": "textfragment"}`
`references`	Array der zitierten Quellendokument-Referenzen.	`{"references": [{ "id": 1, "title": "dateiname.pdf" }]}`
`message_source`	Statusindikator für genutzte Werkzeuge/Retrieval.	`{"source": "UPLOADED_FILES", "status": "RETRIEVED", "count": 3}`
`error`	Während der Generierung ist ein Fehler aufgetreten.	`{"error": "Fehlerbeschreibung"}`
`done`	Stream abgeschlossen.	`{"done": true}`

Beispiel für Streaming-Anfrage

curl -N -X POST "https://connect.omnifact.ai/v1/endpoints/ep_abc123/chat" \
  -H "X-API-Key: ihr_omnifact_api_schluessel_hier" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "role": "user",
        "content": "Fasse unsere Quartalsziele zusammen."
      }
    ],
    "streaming": true
  }'

Beispiel für SSE-Stream-Ausgabe

event: message_source
data: {"source":"UPLOADED_FILES","status":"RETRIEVED","count":2}

event: assistant_write
data: {"delta":"Unsere "}

event: assistant_write
data: {"delta":"Quartalsziele "}

event: assistant_write
data: {"delta":"fokussieren sich auf..."}

event: references
data: {"references":[{"id":1,"title":"Q3_Ziele.pdf"}]}

event: done
data: {"done":true}

Codebeispiele

JavaScript / Node.js
Python

const response = await fetch("https://connect.omnifact.ai/v1/endpoints/ep_abc123/chat", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.OMNIFACT_API_KEY,
    "Content-Type": "application/json",
    "omnifact-enable-inline-sources": "true"
  },
  body: JSON.stringify({
    messages: [
      { role: "user", content: "Wie hoch ist das Budget für Homeoffice-Ausrüstung?" }
    ],
    streaming: false
  })
});

const data = await response.json();
console.log("Assistent:", data.content);

import requests
import os

url = "https://connect.omnifact.ai/v1/endpoints/ep_abc123/chat"
headers = {
    "X-API-Key": os.getenv("OMNIFACT_API_KEY"),
    "Content-Type": "application/json",
    "omnifact-enable-inline-sources": "true"
}
payload = {
    "messages": [
        {"role": "user", "content": "Wie hoch ist das Budget für Homeoffice-Ausrüstung?"}
    ],
    "streaming": False
}

response = requests.post(url, headers=headers, json=payload)
data = response.json()
print("Assistent:", data.get("content"))

Nächste Schritte

Erkunden Sie Dokumentenoperationen mit der Dokumente-API
Lesen Sie die Dokumentation zu Veröffentlichte Spaces, um den Endpunkt-Zugriff zu verwalten

​Endpunkt

​Anfrage-Header

​Anfragenachricht (application/json)

​Antwortmodi

​1. Standard-JSON-Antwort (streaming: false)

​Beispielanfrage

​JSON-Antwort (200 OK)

​2. SSE-Streaming-Antwort (streaming: true)

​SSE-Ereignistypen

​Beispiel für Streaming-Anfrage

​Beispiel für SSE-Stream-Ausgabe

​Codebeispiele

​Nächste Schritte

Endpunkt

Anfrage-Header

Anfragenachricht (`application/json`)

Antwortmodi

1. Standard-JSON-Antwort (`streaming: false`)

Beispielanfrage

JSON-Antwort (`200 OK`)

2. SSE-Streaming-Antwort (`streaming: true`)

SSE-Ereignistypen

Beispiel für Streaming-Anfrage

Beispiel für SSE-Stream-Ausgabe

Codebeispiele

Nächste Schritte