API DocsFertige Agenten

Fertige Agenten

Fertige, OpenAI-kompatible Agenten mit gezieltem Zugriff auf Wissensdatenbanken, Skills und verbundene Apps.

Der fertige RAG-Agent verwendet das OpenAI-Chat-Completions-Format und ergänzt es um mehrere Wissensdatenbank-IDs sowie optionale Skill-IDs.

POST/api/v1/agents/rag/chat/completions

Expliziter Asset-Zugriff

Der Agent kann ausschließlich auf die IDs aus diesem Request zugreifen. Wissensdatenbank-Werkzeuge sind immer verfügbar. Skill-Werkzeuge werden nur eingebunden, wenn skill_ids nicht leer ist.

Request-Body

Übliche Sampling- und Ausgabeparameter werden unterstützt. Der Agent steuert die Tool-Aufrufe selbst: tools, tool_choice, functions und function_call sind nicht zulässig, n ist auf 1 begrenzt. Die Asset-Felder begrenzen den Agenten serverseitig.

Parameter	Type	Default	Description
`model`required	`string`	-	Ein Modell aus dem anymize Modellkatalog.
`messages`required	`array`	-	OpenAI-kompatible Nachrichten in Gesprächsreihenfolge.
`knowledge_base_ids`required	`uuid[]`	-	Eine bis acht zugängliche und fertig verarbeitete Wissensdatenbank-IDs.
`skill_ids`	`uuid[]`	-	Optional bis zu acht zugängliche Skill-IDs. Ohne IDs wird kein Skills-Werkzeug bereitgestellt.
`stream`	`boolean`	`false`	Liefert eine OpenAI-kompatible SSE-Antwort, wenn true.

Vollständiges Beispiel

Bestehende OpenAI-Clients benötigen nur eine andere Base URL und extra_body für die Asset-IDs.

1from openai import OpenAI
2
3client = OpenAI(
4    api_key="YOUR_API_KEY",
5    base_url="https://app.anymize.ai/api/v1/agents/rag",
6)
7
8response = client.chat.completions.create(
9    model="auto",
10    messages=[
11        {"role": "user", "content": "Fasse die Kündigungsregeln zusammen."}
12    ],
13    extra_body={
14        "knowledge_base_ids": ["aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa"],
15        "skill_ids": ["bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb"],
16    },
17)
18
19print(response.choices[0].message.content)
20print(response.citations)

Was der Agent ausführt

Er sucht nur in den angegebenen Wissensdatenbanken und übernimmt exakte Textstellen.

Er lädt nur die explizit angegebenen Skills und bei Bedarf deren Bundle-Dateien.

Er erstellt die Antwort und fügt geschützte, klickbare Links auf jede verwendete Fundstelle ein.

Interne Werkzeugaufrufe bleiben verborgen. Streaming liefert normale OpenAI-SSE-Chunks und am Ende die deduplizierte citations-Liste.

Connected Research Agent

Der fertige Connected Research Agent liest gezielt aus den verbundenen Apps, die du per connector_ids auswählst. Er entdeckt deren Werkzeuge schrittweise und hält den Modellkontext klein.

POST/api/v1/agents/connected-research/chat/completions

Bewusst nur lesend

Dieser stateless Agent entfernt Schreibwerkzeuge technisch. Senden, Erstellen, Aktualisieren und Löschen benötigt später einen eigenen, dauerhaften Freigabeprozess.

Verfügbare Asset-IDs abrufen

Der paginierte Asset-Katalog liefert genau die Wissensdatenbanken, Skills und Connector-Referenzen, die der angemeldete Nutzer auswählen darf. Nutze offset und limit, bis has_more für jede Asset-Familie false ist. Built-ins nutzen zum Beispiel provider:microsoft, eigene MCPs custom:UUID.

GET/api/v1/agents/assets

1curl "https://app.anymize.ai/api/v1/agents/assets?offset=0&limit=100" \
2  -H "Authorization: Bearer YOUR_API_KEY"

Request-Body

Parameter	Type	Default	Description
`model`required	`string`	-	Für Connector-Zugriff ist waterfall-2.0 erforderlich, damit private App-Daten in der geschützten anymize Umgebung bleiben.
`messages`required	`array`	-	OpenAI-kompatible Nachrichten in Gesprächsreihenfolge.
`connector_ids`required	`string[]`	-	Eine bis acht Connector-Referenzen aus GET /api/v1/agents/assets.
`skill_ids`	`uuid[]`	-	Optional bis zu acht zugängliche Skill-IDs. Ohne IDs wird kein Skills-Werkzeug bereitgestellt.
`knowledge_base_ids`	`uuid[]`	-	Optional bis zu acht fertig verarbeitete Wissensdatenbanken für interne Evidenz und klickbare Zitate.
`stream`	`boolean`	`false`	Liefert eine OpenAI-kompatible SSE-Antwort, wenn true.

Kundenbriefing aus Kalender und CRM

Der Agent sieht nur Microsoft 365 und HubSpot aus diesem Request. Andere verbundene Apps bleiben unsichtbar.

1from openai import OpenAI
2
3client = OpenAI(
4    api_key="YOUR_API_KEY",
5    base_url="https://app.anymize.ai/api/v1/agents/connected-research",
6)
7
8response = client.chat.completions.create(
9    model="waterfall-2.0",
10    messages=[
11        {"role": "user", "content": "Fasse meine heutigen Kundentermine und die letzten CRM-Aktivitäten zusammen."}
12    ],
13    extra_body={
14        "connector_ids": [
15            "provider:microsoft",
16            "provider:hubspot",
17        ]
18    },
19)
20
21print(response.choices[0].message.content)

Progressive Tool-Offenlegung

Der Server prüft jede Connector-ID, Compliance-Regeln und aktivierte Bereiche vor dem ersten Modellaufruf.

Das Modell sieht zunächst nur einen Dispatcher und lädt erst die Apps und Werkzeuge, die es für die Aufgabe braucht.

Vor jedem Aufruf werden Berechtigung und Verbindung erneut geprüft. Unbekannte oder schreibende Werkzeuge bleiben entfernt.

Klickbare anymize Chunk-Zitate entstehen für Wissensdatenbank-Treffer. Connector-Ergebnisse können eigene Quelllinks liefern, werden aber nicht als interne Chunk-Zitate ausgegeben.

Skills-MCP

Der gehostete Skills-MCP macht zugängliche anymize Skills für externe MCP-Clients lesbar. Zusammen mit dem Wissensdatenbank-MCP kann ein Agent beide Asset-Arten verwenden.

POST/api/mcp/skills

API-Key erforderlich

Der MCP-Endpunkt akzeptiert ausschließlich Authorization: Bearer. Sitzungs-Cookies werden bewusst nicht verwendet.

Beide Asset-Server verbinden

Binde Wissensdatenbanken und Skills als getrennte MCP-Server ein. So kann der Client Berechtigungen und Werkzeugaufrufe klar unterscheiden.

1{
2  "mcpServers": {
3    "anymize-knowledge": {
4      "url": "https://app.anymize.ai/api/mcp",
5      "headers": { "Authorization": "Bearer YOUR_API_KEY" }
6    },
7    "anymize-skills": {
8      "url": "https://app.anymize.ai/api/mcp/skills",
9      "headers": { "Authorization": "Bearer YOUR_API_KEY" }
10    }
11  }
12}

Verfügbare Werkzeuge

Parameter	Type	Default	Description
`list_skills`	`tool`	-	Listet die Skills auf, auf die der API-Key-Inhaber zugreifen darf.
`get_skill`	`tool`	-	Lädt Metadaten, Anweisungen und die Dateiliste eines Skills per UUID.
`read_skill_file`	`tool`	-	Liest eine einzelne Bundle-Datei eines zugänglichen Skills über einen sicheren relativen Pfad.

Im fertigen RAG-Agenten wird dieser Werkzeugumfang zusätzlich auf skill_ids aus dem jeweiligen Request begrenzt. Automatisch aktive Projekt- oder Team-Skills werden nicht stillschweigend ergänzt.

Klickbare Zitate

Jeder RAG-Treffer enthält chunk_id und citation_url. Der Link öffnet die Quelle in anymize und markiert genau die zitierte Passage.

GET/api/v1/chunks/{chunk_id}

Zitationsvertrag

Die Chunk-UUID identifiziert eine Fundstelle im aktuellen Index. Bei einer erneuten Indexierung kann eine neue UUID entstehen. citation_id und job_id bleiben für bestehende Integrationen verfügbar.

200Klickbare Zitate

{
  "chunk": {
    "id": "cccccccc-cccc-4ccc-8ccc-cccccccccccc",
    "job_id": "dddddddd-dddd-4ddd-8ddd-dddddddddddd",
    "knowledge_base_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
    "content": "Die Kündigungsfrist beträgt drei Monate zum Quartalsende.",
    "chunk_index": 7,
    "source": "vertrag.pdf",
    "page": 4,
    "section": "Laufzeit",
    "citation_url": "https://app.anymize.ai/chunk/cccccccc-cccc-4ccc-8ccc-cccccccccccc"
  }
}

Quelle mit Markierung öffnen

Öffne citation_url direkt aus einer Markdown-Antwort. Nach der Anmeldung lädt anymize das zugehörige Dokument, springt zur Passage und hebt sie hervor.

Zugriff bleibt geschützt

Der Metadaten-Endpunkt prüft Eigentum oder eine bestätigte Wissensdatenbank-Freigabe und antwortet sonst mit 404. Bei anonymisierten Dokumenten wird niemals auf den Klartext zurückgefallen.