API-Referenz
Basis-URL: https://api.coback.ai/api/v1 (selbstgehostet: Ihr Serveradresse + /api/v1).
Jede Anfrage enthält Authorization: Bearer <workspace API key>. Alle Daten sind auf den Arbeitsbereich hinter dem Schlüssel beschränkt. Die vollständige maschinenlesbare Spezifikation befindet sich unter /api/v1/openapi.json.
Konventionen
- Fehler:
{ "error": "<message>" }mit einem 4xx- oder 5xx-Status. - Berechtigungen: Jeder Schlüssel hat Lesezugriff; die untenstehenden Schreib-Endpunkte benötigen einen Schlüssel, der mit Lese‑ und Schreibrechten erstellt wurde. Ein reiner Leseschlüssel erhält dort einen 403.
- Ratenbegrenzung: 120 Anfragen pro Minute pro Schlüssel. 429 mit
Retry-Afterbei Überschreitung.
Identität
| Methode | Pfad | Rückgabe |
|---|---|---|
| GET | /me | Arbeitsbereich-ID und -Name, Firmenname, Schlüsselname, Berechtigungen |
Unternehmenswissen
| Methode | Pfad | Rückgabe |
|---|---|---|
| GET | /brain | Wissenskarten: Typ, Slug, Titel, Zusammenfassung, Prüfstatus |
| GET | /brain/{id} | Eine Karte mit vollständigem Markdown-Inhalt |
| GET | /brain/export | Das gesamte Unternehmenswissen als eine Markdown-Datei (?format=json für strukturiert) |
| GET | /profile | Das extrahierte Unternehmensprofil (digitaler Zwilling) |
Gesetze und Screening
| Methode | Pfad | Rückgabe |
|---|---|---|
| GET | /laws?limit=&offset=&jurisdiction=&since= | Erfasste Gesetze, neueste zuerst |
| GET | /laws/{id}/links | Die Familie eines Gesetzes: Umsetzungen, Änderungen, Leitlinien |
| GET | /law-updates?sinceDays=&jurisdiction=&limit= | Überwachte Updates als reine öffentliche Daten: keine Bewertungen, keine Unternehmensreferenzen, keine Demo-Dokumente. Sicher für externe Inhalte |
| GET | /sources | Die überwachten Quellen mit Autorität und Abdeckung |
| GET | /jurisdictions | Jurisdiktionscodes und -namen |
| GET | /matches | Screening-Ergebnisse, höchste Punktzahl zuerst (bis zu 100) |
| GET | /matches/irrelevant?limit=&offset= | Ausgesonderte Gesetze, mit Begründung |
| GET | /inbox | Screening-Ergebnisse, die eine Entscheidung benötigen (bis zu 100) |
| POST | /matches/{id}/feedback | Datensatz { "verdict": "relevant"|"irrelevant", "note"? } (Schreibberechtigung) |
Arbeit
| Methode | Pfad | Rückgabe |
|---|---|---|
| GET | /tasks | Aufgaben mit Status, Priorität und Quellgesetz |
| POST | /tasks | Erstelle { "title", "description"?, "priority"?, "dueAt"? } (Schreibberechtigung) |
| PATCH | /tasks/{id} | Aktualisiere Status, Titel, Priorität (Schreibberechtigung) |
| GET | /projects | Projekte mit Abteilungsbereiche und Ordnern |
| GET | /comments/{targetType}/{targetId} | Kommentar‑Thread zu einer Aufgabe oder Übereinstimmung |
| POST | /comments/{targetType}/{targetId} | Füge { "body" } hinzu (Schreibberechtigung) |
Dokumente
| Methode | Pfad | Rückgabe |
|---|---|---|
| POST | /corpus/query | Semantische Suche: { "query", "topK"? } über den Dokumentenkorpus |
| POST | /corpus/documents | Multipart‑Upload, Feld files (Schreibberechtigung) |
| POST | /corpus/urls | Einspielen per URL: { "urls": [...] } (Schreibberechtigung) |
Produkt‑Compliance
| Methode | Pfad | Rückgabe |
|---|---|---|
| GET | /compliance/products | Produkte mit Befundzahlen |
| GET | /compliance/products/{id} | Befunde, Stücklistenstatus, Zusammenfassung der besorgniserregenden Substanzen |
| GET | /compliance/products/{id}/gaps | Datenlücken: ungeklärte Zeilen, fehlende Erklärungen |
| GET | /compliance/products/{id}/reports | Managementberichte |
| GET | /compliance/resolutions | Stoffzuordnungen, die auf Überprüfung warten |
Querschnitts‑Funktionen
| Methode | Pfad | Rückgabe |
|---|---|---|
| GET | /activity?limit= | Das Prüfprotokoll: jede Änderung mit Akteur und Zeitstempel |
| GET | /search?q= | Suche über Gesetze, Karten, Aufgaben und Dokumente |
Schreibvorgänge, die mit einem API‑Schlüssel durchgeführt werden, erscheinen im Aktivitätsprotokoll und werden dem Schlüssel (API: <key name>) zugeordnet, sodass die Aktionen eines Agenten nachvollziehbar bleiben.