Einführung

Updates auslösen, KI-Assistent einbetten und mehr

Die Mintlify-REST-API ermöglicht es Ihnen, programmgesteuert mit Ihrer Dokumentation zu interagieren, Updates anzustoßen und KI-gestützte Chat-Erfahrungen einzubetten.

Endpunkte

• Update auslösen: Lösen Sie ein Update Ihrer Site aus, wann immer Sie möchten.
• Update-Status abrufen: Rufen Sie den Status eines Updates und weitere Details zu Ihren Docs ab.
• Assistentennachricht generieren: Betten Sie den Assistenten, der auf Ihren Docs trainiert wurde, in eine beliebige Anwendung ein.
• Dokumentation durchsuchen: Durchsuchen Sie Ihre Dokumentation.

Authentifizierung

Sie können einen API-Schlüssel über das Dashboard erstellen. API-Schlüssel sind einer gesamten Organisation zugeordnet und können in mehreren Bereitstellungen verwendet werden.

Admin-API-Schlüssel

Der Admin-API-Schlüssel wird für die Endpunkte Update auslösen und Update-Status abrufen verwendet.

Admin-API-Schlüssel beginnen mit dem Präfix mint_. Bewahren Sie Ihre Admin-API-Schlüssel geheim auf.

Assistent-API-Schlüssel

Der Assistent-API-Schlüssel wird für die Endpunkte Assistentennachricht erstellen und Dokumentation durchsuchen verwendet.

Assistent-API-Schlüssel beginnen mit dem Präfix mint_dsc_.

Der Assistent-API-Schlüssel ist ein serverseitiges Token, das geheim gehalten werden sollte.

Das Assistent-API-Token ist ein öffentliches Token, das in Ihrem Frontend-Code verwendet werden kann.

Aufrufe mit dem Assistent-API-Token können Kosten verursachen – entweder durch Nutzung Ihrer Assistent-Guthaben oder durch Mehrnutzung.