API-Referenz
Die yeos-API ermöglicht es dir, Dokumentenintelligenz in deine eigenen Anwendungen zu integrieren. Alle API-Endpunkte basieren auf REST und geben JSON-Antworten zurück.
Basis-URL
apiSection.intro.baseUrlValueAuthentifizierung
Alle API-Anfragen erfordern einen API-Schlüssel. Füge deinen Schlüssel als Bearer-Token im Authorization-Header ein.
Authorization: Bearer yeos_your_api_keyInteraktive Dokumentation
Für die vollständige API-Referenz mit Anfrage-/Antwort-Schemata, Beispielen und interaktiven Tests besuche unsere OpenAPI-Dokumentation.
Interaktive Dokumentation ansehenHier sind die wichtigsten API-Endpunkte nach Funktion gruppiert. Für alle Details nutze die OpenAPI-Dokumentation.
Dateien
Lade Dokumente hoch, liste sie auf und verwalte sie in deiner Organisation.
/files/files/files/{id}/files/{id}/chunks/files/{id}/reprocessGespräche
Stelle Fragen und verwalte den Gesprächsverlauf.
/conversations/ask/conversations/conversations/{id}/conversations/{id}Assistenten
Erstelle und verwalte benutzerdefinierte KI-Assistenten.
/agents/agents/agents/{id}/agents/{id}Organisationen
Verwalte Organisationen und Teammitglieder.
/organizations/organizations/organizations/members/organizations/members/organizations/members/{id}/role/organizations/members/{id}API-Schlüssel
Erstelle und verwalte API-Zugriffsschlüssel.
/api-keys/api-keys/api-keys/{id}Werkzeuge
Konfiguriere Assistenten-Werkzeuge und Fähigkeiten.
/tools/toolsVerfügbare Bereiche
API-Schlüssel können auf bestimmte Berechtigungen beschränkt werden. Verwende Scopes, um zu begrenzen, was jeder Schlüssel tun kann.
Format: bereich:aktionVerfügbare Bereiche
conversations – Zugriff auf Gespräche
documents – Zugriff auf Dateien und Dokumente
members – Verwaltung von Teammitgliedern
organization – Organisationseinstellungen
api-keys – Verwaltung von API-Schlüsseln
billing – Abrechnungsvorgänge
Verfügbare Aktionen
read – Ressourcen anzeigen und auflisten
write – Ressourcen erstellen und ändern
delete – Ressourcen entfernen
admin – Administrative Vorgänge
Beispiel-Scopes
conversations:readconversations:read – Gespräche lesendocuments:writedocuments:write – Dokumente hochladenorganization:adminorganization:admin – Vollständige OrganisationskontrolleCode-Beispiele
Schnelle Beispiele, um dir den Einstieg in die API zu erleichtern.
Python
pip install reqüsts
Eine Datei hochladen:
import requests
headers = {
"Authorization": "Bearer yeos_your_api_key",
}
# Upload a file
with open("document.pdf", "rb") as f:
files = {"file": f}
response = requests.post(
"https://cloud.yeos.ai/api/files",
headers=headers,
files=files
)
print(response.json())Eine Frage stellen:
import requests
response = requests.post(
"https://cloud.yeos.ai/api/conversations/ask",
headers={
"Authorization": "Bearer yeos_your_api_key",
"Content-Type": "application/json",
},
json={
"question": "What is the refund policy?",
"organization_id": "your_org_id",
},
)
print(response.json())JavaScript / Node.js
npm install node-fetch
Eine Datei hochladen:
const fetch = require('node-fetch');
const FormData = require('form-data');
const response = await fetch('https://cloud.yeos.ai/api/files', {
method: 'POST',
headers: {
'Authorization': 'Bearer yeos_your_api_key',
},
body: formData,
});
const data = await response.json();
console.log(data);Eine Frage stellen:
const response = await fetch(
'https://cloud.yeos.ai/api/conversations/ask',
{
method: 'POST',
headers: {
'Authorization': 'Bearer yeos_your_api_key',
'Content-Type': 'application/json',
},
body: JSON.stringify({
question: 'What is the refund policy?',
organization_id: 'your_org_id',
}),
}
);
const data = await response.json();
console.log(data);Häufige Fragen
Wie erhalte ich einen API-Schlüssel?
API-Schlüssel werden in deinen Organisationseinstellungen erstellt. Nur Organisationsinhaber und Admins können API-Schlüssel erstellen und verwalten.
Was ist das Rate-Limit?
Rate-Limits hängen von deinem Plan ab. Der kostenlose Plan hat grundlegende Limits, während kostenpflichtige Pläne höhere Rate-Limits für die Produktion bieten.
Kann ich die API ohne Organisation nutzen?
Nein. Alle API-Anfragen sind auf eine Organisation bezogen. Du musst zürst eine Organisation erstellen.
Werden API-Antworten gestreamt?
Ja. Das Beantworten von Fragen unterstützt Server-Sent Events (SSE) für Streaming-Antworten. Prüfe den /conversations/stream-Endpunkt für Details.
Wie gehe ich mit Fehlern um?
Die API gibt standardmäßige HTTP-Statuscodes zurück. 4xx-Fehler weisen auf Client-Probleme hin (fehlerhafte Anfrage, nicht autorisiert), während 5xx-Fehler auf Server-Probleme hinweisen. Prüfe den Antwortkörper für Fehlerdetails.