API-Zugriff
- Der API-Zugriff ist nur für kostenpflichtige Konten möglich
- Sie müssen den API-Zugriff in Ihrem Gehirn aktivieren. Dies kann über die Upload-Seite oder die Seite „Einbetten/Integrieren“ in Ihrem Gehirn erfolgen
- Für jede API-Anfrage sind eine ID und ein API-Schlüssel erforderlich, die von der Upload-Seite oder der Einstellungsseite in Ihrem Gehirn stammen können
- Die Authentifizierung und der API-Zugriff werden pro Gehirn verwaltet, nicht über Ihr gesamtes Konto
- Die Authentifizierung erfolgt über den Anforderungstext der API, nicht über Header
- Denken Sie daran, den Header für Content-Type festzulegen: application/json
- Alle API-Anfragen sind POST-Methoden
- Es gibt eine von der Community erstellte Python-Bibliothek
Fragen stellen, chatten oder suchen
Abfrage-API-Anforderung
Unsere Query-API ermöglicht es einem Benutzer, über einen einfachen API-Aufruf Fragen an Ihr Gehirn zu stellen.
POST https://mybrain.zone/api/1.1/wf/mybrain-query
{ "id": "{myBrain_ID}",
"api_key": "{myBrain_API_Key}",
"query": "Example question?"
}
Abfrage-API-Antwort
{{ "answer": "Brain Assistant is a service that uses Rezolve's Generative AI to answer questions based on content similar to the question.",
"references": [
{
"content": "Brain Assistant uses Rezolve’s Generative AI to answer...",
"link": "https://notion.site/myBrain-FAQs-67644a2a57a24dd6a93ba5b0fcc6d29f",
"score": 0.807668567,
"title": "Brain Assistant: FAQs"
} ...
]
}
Chat-API-Anfrage
Unsere Chat-API ermöglicht es einem Benutzer, über einen einfachen API-Aufruf eine Konversation mit Ihrem Gehirn zu führen. Das messages-Array sollte die Konversation zwischen dem Benutzer und dem Gehirn (Assistenten) enthalten. Sie können die gesamte Konversation innerhalb der API-Anfrage senden.
Jedes Nachrichtenobjekt hat eine Rolle (Benutzer oder Assistent) und einen Inhalt.
Im folgenden Beispiel sehen Sie eine kurze Konversation zwischen einem Benutzer und einem Gehirn. Die Nachricht des Benutzers hat die Rolle: Benutzer und alle Antworten aus dem Gehirn haben die Rolle: Assistent.
POST https://mybrain.zone/api/1.1/wf/mybrain-chat
{ "id": "{myBrain_ID}",
"api_key": "{myBrain_API_Key}",
"messages": [
{
"role": "user",
"content": "What is Brain?"
},
{
"role": "assistant",
"content": "Your Brain is a personalized AI assistant that uses Rezolve's Generative AI to answer your questions based on the content that's similar to your question. It can be accessed through a unique link provided to you after creation, and can be shared with others or embedded on your website using a short code snippet."
},
{
"role": "user",
"content": "How much does it cost?"
}
]
}
Chat-API-Antwort
{ "answer": "Brain Assistant has four different plans, ranging from free to $999 per month. For more details, you can visit their landing page at https://mybrain.zone. It's important to note that there are no additional API costs.",
"references": [
{
"content": "Brain Assistant uses Rezolve’s Generative AI to answer...",
"link": "https://notion.site/myBrain-FAQs-67644a2a57a24dd6a93ba5b0fcc6d29f",
"score": 0.807668567,
"title": "Brain Assistant: FAQs"
} ...
]
}
API-Suchanforderung
Unsere Such-API ermöglicht es Ihnen, alle Inhalte in Ihrem Gehirn über einen einfachen API-Aufruf zu durchsuchen. Es werden nur die Referenzen (Brain-Inhalt) zurückgegeben, im Gegensatz zu den anderen APIs wird keine Antwort auf die Frage gegeben.
POST https://mybrain.zone/api/1.1/wf/mybrain-search
{
"id": "{myBrain_ID}",
"api_key": "{myBrain_API_Key}",
"query": "Example question?"
}
Antwort auf die Such-API
{ "answer": "Search results",
"references": [
{
"author": "null",
"img": "null",
"link": "https://random.notion.site/myBrain-FAQs-67644a2a57a24dd6a93ba5b0fcc6d29f",
"score": 0.807803333,
"section": "null",
"time_stamp": 1682943541.4883738,
"title": "Brain Assistant: FAQs"
} ...
]
}
Inhalt
Unsere Content-API ermöglicht es Ihnen, ganz einfach neue Inhalte in Ihr Gehirn zu pushen, um sein Wissen zu erweitern.
Mit unserer Content API können Sie Webseiten (Links), Texte oder Dateien hinzufügen.
Wichtig:
Sie müssen sicherstellen, dass Inhalte sequenziell mit einer Verzögerung von 5 Sekunden zwischen jeder neuen Anforderung hinzugefügt werden. Dadurch wird sichergestellt, dass Sie unsere API nicht überlasten und alle Ihre Inhalte erfolgreich hinzugefügt werden.
Sie werden sehen, dass neue Inhalte über die API zusammen mit Ihren anderen Inhalten hinzugefügt werden. Um Inhalte zu löschen oder ihren Status zu überprüfen, müssen Sie dies vorerst auf der Inhalts-Upload-Seite Ihres Gehirns tun.
Hinzufügen oder Aktualisieren einer Inhalts-API-Anforderung
POST https://mybrain.zone/api/1.1/wf/mybrain-content
Hinzufügen von Links/URLs:
Verwenden Sie den folgenden Text, um Webseiten/Links zu Ihrem Gehirn hinzuzufügen. Diese müssen öffentlich zugänglich sein und dürfen keine Dateien sein.
Die einzigen optionalen Felder sind meta_author, meta_link, meta_published (die MM/TT/JJJ oder ein Epoch Unix-Zeitstempel als Zeichenfolge sein können) und content_id.
{ "id": "{myBrain_ID}",
"api_key": "{myBrain_API_Key}",
"webpage": "https://example.com",
"meta_title": "Example content title",
"meta_published": "MM/DD/YYYY",
"meta_author": "Example Company",
"meta_link": "https://example.com"
}
Hinzufügen von Dateien:
Verwenden Sie den folgenden Text, um eine einzelne Datei (unter 25 MB) zu Ihrem Gehirn hinzuzufügen. Dateien können nur .PDF, .TXT oder .DOCX sein.
Die einzigen optionalen Felder sind meta_author, meta_link und content_id.
{ "id": "{myBrain_ID}",
"api_key": "{myBrain_API_Key}",
"file_url": "https://example.com",
"meta_title": "Example content title",
"meta_published": "MM/DD/YYYY",
"meta_author": "Example Company",
"meta_link": "https://example.com"
}
Text hinzufügen:
Verwenden Sie den folgenden Text, um Ihrem Gehirn Rohtext hinzuzufügen. Dieser Text muss JSON-sicher sein.
Die einzigen optionalen Felder sind meta_author, meta_link und content_id.
{ "id": "{myBrain_ID}",
"api_key": "{myBrain_API_Key}",
"text": "This is some example content",
"meta_title": "Example content title",
"meta_published": "MM/DD/YYYY",
"meta_author": "Example Company",
"meta_link": "https://example.com",
"client_id": "001"
}
Aktualisieren von Inhalten:
Derselbe API-Aufruf wird ausgeführt, um vorhandene Inhalte zu aktualisieren.
- Um ein Webseiteninhaltselement zu aktualisieren, müssen Sie nur den gleichen API-Aufruf zum Hinzufügen von Inhalten ausführen, um sicherzustellen, dass der Wert der Webseite mit dem zuvor hinzugefügten Wert übereinstimmt. Neue Inhalte, die von der Webseite gescrapt wurden, überschreiben alle Inhalte, die zuvor für diese Webseite gescrapt wurden.
- Wenn dieselbe Webseite hinzugefügt wird, wird der vorhandene Webseiteninhalt in Ihrem Gehirn überschrieben, es wird nicht dupliziert.
- Um ein Datei- oder Textinhaltselement zu aktualisieren, müssen Sie ein zusätzliches file_id Feld in Ihre Anfrage aufnehmen, der Wert dafür wird als content_id einer erfolgreichen Antwort auf die Anforderung zum Hinzufügen bereitgestellt (siehe unten)
Hinzufügen oder Aktualisieren einer Inhalts-API-Anforderung
Wenn das Anforderungsformat gültig ist, gibt die API die folgende Antwort zurück. Ihr Inhalt wird dann im Hintergrund verarbeitet und dauert länger, wenn es sich um einen großen Inhalt handelt. Diese content_id kann verwendet werden, um dieses Inhaltselement zu aktualisieren oder zu löschen.
Sobald der Inhalt erfolgreich hinzugefügt wurde, wird er auf Ihrer Brain-Upload-Seite angezeigt und Sie können Fragen zu diesem Inhalt stellen.
{ "status": "success",
"response": {
"content_id": "1682755",
"status": "success"
}
}
Inhalts-API-Anforderung löschen
Um Inhalte zu löschen, müssen Sie entweder eine Webseite, file_id (die beim ersten Hinzufügen zu Ihrem Gehirn als content_id zurückgegeben wird) oder client_idaus.
POST https://mybrain.zone/api/1.1/wf/mybrain-content-delete
{ "id": "{myBrain_ID}",
"api_key": "{myBrain_API_Key}",
"webpage": "https://website.com",
"file_id": "487dh234s2x35973d5jt",
"client_id": "001"
}
Abrufen einer bestimmten Inhalts-API-Anforderung
Sie können ein einzelnes Inhaltselement aus Ihrem Gehirn abrufen, Sie müssen entweder eine Webseite, file_id(wird als content_id zurückgegeben, wenn Sie zum ersten Mal zu Ihrem Gehirn hinzugefügt werden) oder client_id. Dies ist hilfreich, um den Status eines hinzugefügten Inhalts anzuzeigen und sicherzustellen, dass er erfolgreich hinzugefügt wurde.
POST https://mybrain.zone/api/1.1/wf/mybrain-content-retrieve
{ "id": "{myBrain_ID}",
"api_key": "{myBrain_API_Key}",
"webpage": "https://website.com",
"file_id": "487dh234s2x35973d5jt",
"client_id": "001"
}
Alle Inhalts-API-Anfragen durchsuchen
Sie können alle Inhaltselemente in Ihrem Gehirn durchsuchen. Bereitstellen eines Webseitensuchbegriffs oder eines Titelsuchbegriffs. Die API sucht nach Inhalten, die das von Ihnen bereitgestellte Schlüsselwort entweder teilweise oder genau enthalten.
Die 50 besten Ergebnisse werden zurückgegeben. Geben Sie nur den Titel oder die Webseite an, nicht beides.
POST https://mybrain.zone/api/1.1/wf/mybrain-content-retrieve-all
{ "id": "{myBrain_ID}",
"api_key": "{myBrain_API_Key}",
"title": "Example title", //optional
"webpage": "https://webpage.com/blog"
}
Gehirn erstellen
Sie können ein Gehirn über die API erstellen, dann Inhalte hinzufügen und dann mit der Abfrage beginnen. Bitte senden Sie uns eine E-Mail an team@mybrain.zone von der E-Mail-Adresse, die mit Ihrem Konto für Ihr Konto verknüpft ist, api_key.
POST https://mybrain.zone/api/1.1/wf/create-mybrain
{ "id": "{myBrain_ID}",
"api_key": "{myBrain_API_Key}"
}