API-Referenz

Sam AI

Sam AI schreibt deine Antworten in den Unterhaltungen deiner Kampagnen. Er liest Anweisungen und Dateien auf drei Ebenen, im X-Konto für dein Business, in der Persona dafür, wie man diesem Käufertyp verkauft, und in der Unterhaltung für genau diesen einen Lead. Widersprechen sich zwei Ebenen, gewinnt die genauere.

Eine Unterhaltung läuft in einem von drei Modi. off überlässt sie dir. draft ist der Modus Halbautomatisch, Sam AI schreibt einen Vorschlag und du sendest ihn. auto lässt Sam AI seine Antworten selbstständig von deinem X-Konto aus senden. Eine Persona legt den Modus ihrer Unterhaltungen fest, und eine Unterhaltung kann einen eigenen haben oder mit inherit den ihrer Persona übernehmen.

Sam AI läuft mit den Tarifen Business und Enterprise, und nur in laufenden Kampagnen. Unter Business schreibt er nichts, weder in draft noch in auto. Eine Antwort von Sam AI kostet 30 Credits, sobald sie rausgeht, egal wie viele Nachrichten sie enthält. Ein Vorschlag, den du nicht sendest, ist kostenlos, aber Sam AI schreibt nur dann einen, wenn dein Guthaben eine Antwort deckt. Neue Vorschläge, die Antworten, die Sam AI sendet, und seine Übergaben kommen auch als Webhooks sam.suggestion.ready, sam.reply.sent und sam.handoff.

Das Sam AI-Objekt des Kontos

Sam AI im ganzen X-Konto, sein Schalter und was er über dein Business weiß.

Attribute

  • objectstring
    Immer account_sam.
  • account_idstring
    Die ID des X-Kontos, wie im Kontoobjekt.
  • enabledboolean
    false, wenn Sam AI in allen Unterhaltungen des X-Kontos aus ist, egal in welchem Modus.
  • instructionsstring
    Was dein Business ausmacht, in jeder Unterhaltung gelesen, etwa dein Angebot, deine Preise, deine Garantie und deine Links. Bis zu 3 000 Zeichen.
  • filesArray von objects
    Die Dateien, die Sam AI in jeder Unterhaltung liest, als Sam AI-Dateiobjekte.
Das Sam AI-Objekt des Kontos
{
  "object": "account_sam",
  "account_id": "a9PzK2vRtM",
  "enabled": true,
  "instructions": "Acme lets creators charge for their Discord. 5 percent a sale, no monthly fee, payouts every week. Sign up at https://acme.com/start.",
  "files": [
    {
      "id": "sf_4c1e9a07d2b35f68e190",
      "object": "sam_file",
      "name": "Pricing and payouts.pdf",
      "size": 182344,
      "mime_type": "application/pdf",
      "url": "https://upcdn.io/W142hYH/raw/uploads/GemleadSamFiles/api/7f3a9c21e5b04d18/Pricing-and-payouts.pdf"
    }
  ]
}

Sam AI des Kontos abrufen

GET/v1/account/samScope readMCPget_sam_settings

Gibt zurück, ob Sam AI für das X-Konto an ist, dazu die Business-Infos und die Dateien.

Rückgabe

Das Sam AI-Objekt des Kontos.

GET/v1/account/sam
curl https://gemlead.ai/api/v1/account/sam \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"
Antwort200
{
  "object": "account_sam",
  "account_id": "a9PzK2vRtM",
  "enabled": true,
  "instructions": "Acme lets creators charge for their Discord. 5 percent a sale, no monthly fee, payouts every week. Sign up at https://acme.com/start.",
  "files": [
    {
      "id": "sf_4c1e9a07d2b35f68e190",
      "object": "sam_file",
      "name": "Pricing and payouts.pdf",
      "size": 182344,
      "mime_type": "application/pdf",
      "url": "https://upcdn.io/W142hYH/raw/uploads/GemleadSamFiles/api/7f3a9c21e5b04d18/Pricing-and-payouts.pdf"
    }
  ]
}

Sam AI des Kontos ändern

PATCH/v1/account/samScope writeMCPupdate_sam_settings

Schaltet Sam AI für das ganze X-Konto ein oder aus oder ändert die Business-Infos, die jede Unterhaltung liest. Nur die gesendeten Felder ändern sich.

Body-Parameter

  • enabledboolean
    false schaltet Sam AI in allen Unterhaltungen des X-Kontos aus, true schaltet ihn wieder ein.
  • instructionsstring
    Was dein Business ausmacht, bis zu 3 000 Zeichen. Ein leerer String löscht den Text.

Rückgabe

Das aktualisierte Sam AI-Objekt des Kontos.

Fehler

  • Ein Parameter hat einen Wert, den die API nicht akzeptiert. param nennt ihn.
  • Der Body enthält ein Feld, das dieser Endpoint nicht akzeptiert.
  • Der Schlüssel eines Teammitglieds ändert einen Bereich, den seine Rolle nur ansehen darf. Der Schalter des X-Kontos und die Unterhaltungen liegen im Bereich Chat, Business-Infos und Dateien in den Einstellungen, Sam AI einer Persona im Bereich Personas.
PATCH/v1/account/sam
curl -X PATCH https://gemlead.ai/api/v1/account/sam \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "instructions": "Acme lets creators charge for their Discord. 5 percent a sale, no monthly fee, payouts every week. Sign up at https://acme.com/start."
  }'
Antwort200
{
  "object": "account_sam",
  "account_id": "a9PzK2vRtM",
  "enabled": true,
  "instructions": "Acme lets creators charge for their Discord. 5 percent a sale, no monthly fee, payouts every week. Sign up at https://acme.com/start.",
  "files": [
    {
      "id": "sf_4c1e9a07d2b35f68e190",
      "object": "sam_file",
      "name": "Pricing and payouts.pdf",
      "size": 182344,
      "mime_type": "application/pdf",
      "url": "https://upcdn.io/W142hYH/raw/uploads/GemleadSamFiles/api/7f3a9c21e5b04d18/Pricing-and-payouts.pdf"
    }
  ]
}

Das Sam AI-Objekt der Persona

Sam AI in einer Persona, für die Unterhaltungen mit ihren Leads.

Attribute

  • objectstring
    Immer persona_sam.
  • persona_idstring
    Die ID der Persona.
  • modestring
    Der Modus der Unterhaltungen der Persona, die keinen eigenen haben. off überlässt sie dir, draft ist Halbautomatisch, Sam AI schlägt vor und du sendest, auto lässt Sam AI selbstständig senden. draft, bis du ihn änderst.
    offdraftauto
  • instructionsstring
    Wie man diesem Käufertyp schreibt und verkauft, in der App die Anweisungen der Persona. Bis zu 6 000 Zeichen.
  • filesArray von objects
    Die Dateien, die Sam AI in den Unterhaltungen der Persona liest, als Sam AI-Dateiobjekte.
Das Sam AI-Objekt der Persona
{
  "object": "persona_sam",
  "persona_id": "lvWBPnytpS",
  "mode": "draft",
  "instructions": "Tipsters want to get paid on time. Lead with the weekly payouts, keep it to two short messages, and offer the link once they ask how.",
  "files": []
}

Sam AI einer Persona abrufen

GET/v1/personas/:persona_id/samScope readMCPget_sam_settings

Gibt den Modus von Sam AI für die Unterhaltungen der Persona zurück, ihre Anweisungen und ihre Dateien.

Pfadparameter

  • persona_idstringErforderlich
    Die ID der Persona.

Rückgabe

Das Sam AI-Objekt der Persona.

Fehler

GET/v1/personas/:persona_id/sam
curl https://gemlead.ai/api/v1/personas/lvWBPnytpS/sam \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"
Antwort200
{
  "object": "persona_sam",
  "persona_id": "lvWBPnytpS",
  "mode": "draft",
  "instructions": "Tipsters want to get paid on time. Lead with the weekly payouts, keep it to two short messages, and offer the link once they ask how.",
  "files": []
}

Sam AI einer Persona ändern

PATCH/v1/personas/:persona_id/samScope writeMCPupdate_sam_settings

Ändert den Modus von Sam AI in den Unterhaltungen der Persona, die keinen eigenen Modus haben, oder die Anweisungen der Persona. Nur die gesendeten Felder ändern sich. auto sendet Antworten selbstständig von deinem X-Konto aus.

Pfadparameter

  • persona_idstringErforderlich
    Die ID der Persona.

Body-Parameter

  • modestring
    Der Modus von Sam AI in den Unterhaltungen der Persona.
    offdraftauto
  • instructionsstring
    Wie man diesem Käufertyp schreibt und verkauft, bis zu 6 000 Zeichen. Ein leerer String löscht den Pitch.

Rückgabe

Das aktualisierte Sam AI-Objekt der Persona.

Fehler

  • Keine Persona mit dieser ID im Konto des Schlüssels.
  • Ein Parameter hat einen Wert, den die API nicht akzeptiert. param nennt ihn.
  • Der Body enthält ein Feld, das dieser Endpoint nicht akzeptiert.
  • auto bei einem Konto unter dem Business-Tarif.
  • Der Schlüssel eines Teammitglieds ändert einen Bereich, den seine Rolle nur ansehen darf. Der Schalter des X-Kontos und die Unterhaltungen liegen im Bereich Chat, Business-Infos und Dateien in den Einstellungen, Sam AI einer Persona im Bereich Personas.
PATCH/v1/personas/:persona_id/sam
curl -X PATCH \
  https://gemlead.ai/api/v1/personas/lvWBPnytpS/sam \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "draft"
  }'
Antwort200
{
  "object": "persona_sam",
  "persona_id": "lvWBPnytpS",
  "mode": "draft",
  "instructions": "Tipsters want to get paid on time. Lead with the weekly payouts, keep it to two short messages, and offer the link once they ask how.",
  "files": []
}

Das Sam AI-Objekt der Unterhaltung

Sam AI in einer Unterhaltung, sein Modus, die Antwort, die er bereithält, und was er über diesen Lead weiß.

Attribute

  • objectstring
    Immer conversation_sam.
  • conversation_idstring
    Die ID der Unterhaltung.
  • modestring
    Der eigene Modus der Unterhaltung, oder inherit, wenn sie dem ihrer Persona folgt.
    offdraftautoinherit
  • effective_modestring
    Der Modus, der tatsächlich gilt. off, wenn Sam AI im X-Konto aus ist, die Unterhaltung in keiner laufenden Kampagne ist oder das Konto einen Tarif unter Business hat.
    offdraftauto
  • personaobject oder null
    Die Persona, die Sam AI liest, mit id, name und mode.
  • campaignobject oder null
    Die Kampagne, in der die Unterhaltung läuft, mit id und name. Sam AI antwortet nur in einer laufenden Kampagne.
  • statusstring
    Was Sam AI gerade tut. writing, während er eine Antwort schreibt, suggested, wenn eine auf dich wartet, scheduled, wenn sie um suggestion.send_at selbstständig rausgeht, sending, sent, no_reply, wenn er beschlossen hat, nicht zu antworten, handoff, wenn er dir die Unterhaltung übergibt, no_credits, wenn das Guthaben unter den 30 Credits einer Antwort liegt, off oder idle.
    idlewritingsuggestedscheduledsendingsentno_replyhandoffno_creditsoff
  • reasonstring oder null
    Der Grund bei no_reply und handoff, so wie Sam AI ihn formuliert hat.
  • suggestionobject oder null
    Die Antwort, die Sam AI bereithält, solange status auf suggested, scheduled oder sending steht.
  • instructionsstring
    Was Sam AI über genau diesen Lead wissen soll. Bis zu 3 000 Zeichen.
  • filesArray von objects
    Die Dateien, die Sam AI nur in dieser Unterhaltung liest, als Sam AI-Dateiobjekte.
  • updated_atstring oder null
    Wann sich der Zustand von Sam AI zuletzt geändert hat, ISO 8601.
Das Sam AI-Objekt der Unterhaltung
{
  "object": "conversation_sam",
  "conversation_id": "msgOtJ8dvT",
  "mode": "inherit",
  "effective_mode": "draft",
  "persona": {
    "id": "lvWBPnytpS",
    "name": "Tipsters",
    "mode": "draft"
  },
  "campaign": {
    "id": "c7RkQ2wLxe",
    "name": "Tipsters warm intro"
  },
  "status": "suggested",
  "reason": null,
  "suggestion": {
    "messages": [
      "It takes two minutes. You set a price, members pay, and they get their Discord role right away.",
      "Want the link to set it up?"
    ],
    "edited": false,
    "stage": "answer_question",
    "why": "She asked how it works, so the reply explains it in one line and offers the link.",
    "replying_to_message_id": "1985321409876543210",
    "created_at": "2026-11-06T08:13:20.000Z",
    "send_at": null
  },
  "instructions": "She runs two Discords. Talk about the bigger one first.",
  "files": [],
  "updated_at": "2026-11-06T08:13:20.000Z"
}

Sam AI einer Unterhaltung abrufen

GET/v1/conversations/:conversation_id/samScope readMCPget_sam_settings

Gibt den Modus von Sam AI in der Unterhaltung zurück und den, der tatsächlich gilt, die Antwort, die er bereithält, sowie die eigenen Anweisungen und Dateien der Unterhaltung.

Pfadparameter

  • conversation_idstringErforderlich
    Die ID der Unterhaltung.

Rückgabe

Das Sam AI-Objekt der Unterhaltung.

Fehler

GET/v1/conversations/:conversation_id/sam
curl https://gemlead.ai/api/v1/conversations/msgOtJ8dvT/sam \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"
Antwort200
{
  "object": "conversation_sam",
  "conversation_id": "msgOtJ8dvT",
  "mode": "inherit",
  "effective_mode": "draft",
  "persona": {
    "id": "lvWBPnytpS",
    "name": "Tipsters",
    "mode": "draft"
  },
  "campaign": {
    "id": "c7RkQ2wLxe",
    "name": "Tipsters warm intro"
  },
  "status": "suggested",
  "reason": null,
  "suggestion": {
    "messages": [
      "It takes two minutes. You set a price, members pay, and they get their Discord role right away.",
      "Want the link to set it up?"
    ],
    "edited": false,
    "stage": "answer_question",
    "why": "She asked how it works, so the reply explains it in one line and offers the link.",
    "replying_to_message_id": "1985321409876543210",
    "created_at": "2026-11-06T08:13:20.000Z",
    "send_at": null
  },
  "instructions": "She runs two Discords. Talk about the bigger one first.",
  "files": [],
  "updated_at": "2026-11-06T08:13:20.000Z"
}

Sam AI einer Unterhaltung ändern

PATCH/v1/conversations/:conversation_id/samScope writeMCPupdate_sam_settings

Legt den Modus von Sam AI nur für diese Unterhaltung fest, überlässt ihn mit inherit wieder ihrer Persona oder ändert, was Sam AI über diesen Lead weiß. Nur die gesendeten Felder ändern sich. auto sendet Antworten selbstständig von deinem X-Konto aus.

Pfadparameter

  • conversation_idstringErforderlich
    Die ID der Unterhaltung.

Body-Parameter

  • modestring
    Der Modus von Sam AI in dieser Unterhaltung. inherit folgt dem der Persona.
    offdraftautoinherit
  • instructionsstring
    Was Sam AI über diesen Lead wissen soll, bis zu 3 000 Zeichen. Ein leerer String löscht den Text.

Rückgabe

Das aktualisierte Sam AI-Objekt der Unterhaltung.

Fehler

  • Keine Unterhaltung mit dieser ID im Konto des Schlüssels.
  • Ein Parameter hat einen Wert, den die API nicht akzeptiert. param nennt ihn.
  • Der Body enthält ein Feld, das dieser Endpoint nicht akzeptiert.
  • auto bei einem Konto unter dem Business-Tarif.
  • Der Schlüssel eines Teammitglieds ändert einen Bereich, den seine Rolle nur ansehen darf. Der Schalter des X-Kontos und die Unterhaltungen liegen im Bereich Chat, Business-Infos und Dateien in den Einstellungen, Sam AI einer Persona im Bereich Personas.
PATCH/v1/conversations/:conversation_id/sam
curl -X PATCH \
  https://gemlead.ai/api/v1/conversations/msgOtJ8dvT/sam \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "auto"
  }'
Antwort200
{
  "object": "conversation_sam",
  "conversation_id": "msgOtJ8dvT",
  "mode": "auto",
  "effective_mode": "auto",
  "persona": {
    "id": "lvWBPnytpS",
    "name": "Tipsters",
    "mode": "draft"
  },
  "campaign": {
    "id": "c7RkQ2wLxe",
    "name": "Tipsters warm intro"
  },
  "status": "scheduled",
  "reason": null,
  "suggestion": {
    "messages": [
      "It takes two minutes. You set a price, members pay, and they get their Discord role right away.",
      "Want the link to set it up?"
    ],
    "edited": false,
    "stage": "answer_question",
    "why": "She asked how it works, so the reply explains it in one line and offers the link.",
    "replying_to_message_id": "1985321409876543210",
    "created_at": "2026-11-06T08:13:20.000Z",
    "send_at": "2026-11-06T08:14:05.000Z"
  },
  "instructions": "She runs two Discords. Talk about the bigger one first.",
  "files": [],
  "updated_at": "2026-11-06T08:13:20.000Z"
}

Das Sam AI-Dateiobjekt

Ein Dokument, das Sam AI vor jeder Antwort liest, eine PDF-, DOCX-, TXT-, MD- oder CSV-Datei. Jede Ebene fasst höchstens 30 Dateien und 100 MB.

Attribute

  • idstring
    Eindeutige Kennung der Datei auf ihrer Ebene.
  • objectstring
    Immer sam_file.
  • namestring
    Der Name der Datei, so wie die App ihn anzeigt.
  • sizeinteger
    Ihre Größe in Bytes.
  • mime_typestring oder null
    Ihr Typ, etwa application/pdf.
  • urlstring
    Wo Gemlead sie speichert.
Das Sam AI-Dateiobjekt
{
  "id": "sf_4c1e9a07d2b35f68e190",
  "object": "sam_file",
  "name": "Pricing and payouts.pdf",
  "size": 182344,
  "mime_type": "application/pdf",
  "url": "https://upcdn.io/W142hYH/raw/uploads/GemleadSamFiles/api/7f3a9c21e5b04d18/Pricing-and-payouts.pdf"
}

Datei zum Konto hinzufügen

POST/v1/account/sam/filesScope writeMCPedit_sam_files

Gibt Sam AI ein Dokument, das er in jeder Unterhaltung des X-Kontos liest. Sende seine öffentliche URL oder seine Bytes in base64. Gemlead liest es einmal, prüft, ob es eine PDF-, DOCX-, TXT-, MD- oder CSV-Datei ist, und behält eine eigene Kopie.

Body-Parameter

  • urlstring
    Die Datei unter einer öffentlichen HTTPS-URL. Gemlead liest sie einmal und behält eine eigene Kopie. Gib url oder data an.
  • datastring
    Die Datei, base64-codiert, statt url. Sende eine große Datei als url.
  • namestring
    Der Name, den die App anzeigt, bis zu 200 Zeichen. Pflichtfeld bei data, sonst der letzte Teil der URL. Gemlead ergänzt die Endung, wenn sie fehlt.

Rückgabe

Das neue Sam AI-Dateiobjekt.

Fehler

  • Ein Pflichtparameter fehlt. param nennt ihn.
  • Die Datei ist keine PDF-, DOCX-, TXT-, MD- oder CSV-Datei, ist leer oder größer als 25 MB, oder ihre URL lässt sich nicht lesen. param nennt den Parameter.
  • Der Body enthält ein Feld, das dieser Endpoint nicht akzeptiert.
  • Die Ebene enthält schon 30 Dateien oder 100 MB an Dateien. Lösche zuerst eine.
  • Mehr als 100 Dateien pro Stunde in diesem X-Konto.
  • Der Schlüssel eines Teammitglieds ändert einen Bereich, den seine Rolle nur ansehen darf. Der Schalter des X-Kontos und die Unterhaltungen liegen im Bereich Chat, Business-Infos und Dateien in den Einstellungen, Sam AI einer Persona im Bereich Personas.
POST/v1/account/sam/files
curl -X POST https://gemlead.ai/api/v1/account/sam/files \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://acme.com/docs/pricing-and-payouts.pdf",
    "name": "Pricing and payouts.pdf"
  }'
Antwort200
{
  "id": "sf_4c1e9a07d2b35f68e190",
  "object": "sam_file",
  "name": "Pricing and payouts.pdf",
  "size": 182344,
  "mime_type": "application/pdf",
  "url": "https://upcdn.io/W142hYH/raw/uploads/GemleadSamFiles/api/7f3a9c21e5b04d18/Pricing-and-payouts.pdf"
}

Datei des Kontos löschen

DELETE/v1/account/sam/files/:file_idScope writeMCPedit_sam_files

Nimmt eine Datei von der Ebene. Ab seiner nächsten Antwort liest Sam AI sie nicht mehr.

Pfadparameter

  • file_idstringErforderlich
    Die ID der Sam AI-Datei.

Rückgabe

Ein Objekt mit der id der Datei und dem Wert true in deleted.

Fehler

  • Keine Sam AI-Datei mit dieser ID im Konto des Schlüssels.
  • Der Schlüssel eines Teammitglieds ändert einen Bereich, den seine Rolle nur ansehen darf. Der Schalter des X-Kontos und die Unterhaltungen liegen im Bereich Chat, Business-Infos und Dateien in den Einstellungen, Sam AI einer Persona im Bereich Personas.
DELETE/v1/account/sam/files/:file_id
curl -X DELETE \
  https://gemlead.ai/api/v1/account/sam/files/sf_4c1e9a07d2b35f68e190 \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"
Antwort200
{
  "id": "sf_4c1e9a07d2b35f68e190",
  "object": "sam_file",
  "deleted": true
}

Datei zu einer Persona hinzufügen

POST/v1/personas/:persona_id/sam/filesScope writeMCPedit_sam_files

Gibt Sam AI ein Dokument, das er in den Unterhaltungen der Persona liest. Sende seine öffentliche URL oder seine Bytes in base64. Gemlead liest es einmal, prüft, ob es eine PDF-, DOCX-, TXT-, MD- oder CSV-Datei ist, und behält eine eigene Kopie.

Pfadparameter

  • persona_idstringErforderlich
    Die ID der Persona.

Body-Parameter

  • urlstring
    Die Datei unter einer öffentlichen HTTPS-URL. Gemlead liest sie einmal und behält eine eigene Kopie. Gib url oder data an.
  • datastring
    Die Datei, base64-codiert, statt url. Sende eine große Datei als url.
  • namestring
    Der Name, den die App anzeigt, bis zu 200 Zeichen. Pflichtfeld bei data, sonst der letzte Teil der URL. Gemlead ergänzt die Endung, wenn sie fehlt.

Rückgabe

Das neue Sam AI-Dateiobjekt.

Fehler

  • Keine Persona mit dieser ID im Konto des Schlüssels.
  • Ein Pflichtparameter fehlt. param nennt ihn.
  • Die Datei ist keine PDF-, DOCX-, TXT-, MD- oder CSV-Datei, ist leer oder größer als 25 MB, oder ihre URL lässt sich nicht lesen. param nennt den Parameter.
  • Der Body enthält ein Feld, das dieser Endpoint nicht akzeptiert.
  • Die Ebene enthält schon 30 Dateien oder 100 MB an Dateien. Lösche zuerst eine.
  • Mehr als 100 Dateien pro Stunde in diesem X-Konto.
  • Der Schlüssel eines Teammitglieds ändert einen Bereich, den seine Rolle nur ansehen darf. Der Schalter des X-Kontos und die Unterhaltungen liegen im Bereich Chat, Business-Infos und Dateien in den Einstellungen, Sam AI einer Persona im Bereich Personas.
POST/v1/personas/:persona_id/sam/files
curl -X POST \
  https://gemlead.ai/api/v1/personas/lvWBPnytpS/sam/files \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://acme.com/docs/pricing-and-payouts.pdf",
    "name": "Pricing and payouts.pdf"
  }'
Antwort200
{
  "id": "sf_4c1e9a07d2b35f68e190",
  "object": "sam_file",
  "name": "Pricing and payouts.pdf",
  "size": 182344,
  "mime_type": "application/pdf",
  "url": "https://upcdn.io/W142hYH/raw/uploads/GemleadSamFiles/api/7f3a9c21e5b04d18/Pricing-and-payouts.pdf"
}

Datei einer Persona löschen

DELETE/v1/personas/:persona_id/sam/files/:file_idScope writeMCPedit_sam_files

Nimmt eine Datei von der Ebene. Ab seiner nächsten Antwort liest Sam AI sie nicht mehr.

Pfadparameter

  • persona_idstringErforderlich
    Die ID der Persona.
  • file_idstringErforderlich
    Die ID der Sam AI-Datei.

Rückgabe

Ein Objekt mit der id der Datei und dem Wert true in deleted.

Fehler

  • Keine Sam AI-Datei mit dieser ID im Konto des Schlüssels.
  • Der Schlüssel eines Teammitglieds ändert einen Bereich, den seine Rolle nur ansehen darf. Der Schalter des X-Kontos und die Unterhaltungen liegen im Bereich Chat, Business-Infos und Dateien in den Einstellungen, Sam AI einer Persona im Bereich Personas.
DELETE/v1/personas/:persona_id/sam/files/:file_id
curl -X DELETE \
  https://gemlead.ai/api/v1/personas/lvWBPnytpS/sam/files/sf_4c1e9a07d2b35f68e190 \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"
Antwort200
{
  "id": "sf_4c1e9a07d2b35f68e190",
  "object": "sam_file",
  "deleted": true
}

Datei zu einer Unterhaltung hinzufügen

POST/v1/conversations/:conversation_id/sam/filesScope writeMCPedit_sam_files

Gibt Sam AI ein Dokument über genau diesen Lead. Sende seine öffentliche URL oder seine Bytes in base64. Gemlead liest es einmal, prüft, ob es eine PDF-, DOCX-, TXT-, MD- oder CSV-Datei ist, und behält eine eigene Kopie.

Pfadparameter

  • conversation_idstringErforderlich
    Die ID der Unterhaltung.

Body-Parameter

  • urlstring
    Die Datei unter einer öffentlichen HTTPS-URL. Gemlead liest sie einmal und behält eine eigene Kopie. Gib url oder data an.
  • datastring
    Die Datei, base64-codiert, statt url. Sende eine große Datei als url.
  • namestring
    Der Name, den die App anzeigt, bis zu 200 Zeichen. Pflichtfeld bei data, sonst der letzte Teil der URL. Gemlead ergänzt die Endung, wenn sie fehlt.

Rückgabe

Das neue Sam AI-Dateiobjekt.

Fehler

  • Keine Unterhaltung mit dieser ID im Konto des Schlüssels.
  • Ein Pflichtparameter fehlt. param nennt ihn.
  • Die Datei ist keine PDF-, DOCX-, TXT-, MD- oder CSV-Datei, ist leer oder größer als 25 MB, oder ihre URL lässt sich nicht lesen. param nennt den Parameter.
  • Der Body enthält ein Feld, das dieser Endpoint nicht akzeptiert.
  • Die Ebene enthält schon 30 Dateien oder 100 MB an Dateien. Lösche zuerst eine.
  • Mehr als 100 Dateien pro Stunde in diesem X-Konto.
  • Der Schlüssel eines Teammitglieds ändert einen Bereich, den seine Rolle nur ansehen darf. Der Schalter des X-Kontos und die Unterhaltungen liegen im Bereich Chat, Business-Infos und Dateien in den Einstellungen, Sam AI einer Persona im Bereich Personas.
POST/v1/conversations/:conversation_id/sam/files
curl -X POST \
  https://gemlead.ai/api/v1/conversations/msgOtJ8dvT/sam/files \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://acme.com/docs/pricing-and-payouts.pdf",
    "name": "Pricing and payouts.pdf"
  }'
Antwort200
{
  "id": "sf_4c1e9a07d2b35f68e190",
  "object": "sam_file",
  "name": "Pricing and payouts.pdf",
  "size": 182344,
  "mime_type": "application/pdf",
  "url": "https://upcdn.io/W142hYH/raw/uploads/GemleadSamFiles/api/7f3a9c21e5b04d18/Pricing-and-payouts.pdf"
}

Datei einer Unterhaltung löschen

DELETE/v1/conversations/:conversation_id/sam/files/:file_idScope writeMCPedit_sam_files

Nimmt eine Datei von der Ebene. Ab seiner nächsten Antwort liest Sam AI sie nicht mehr.

Pfadparameter

  • conversation_idstringErforderlich
    Die ID der Unterhaltung.
  • file_idstringErforderlich
    Die ID der Sam AI-Datei.

Rückgabe

Ein Objekt mit der id der Datei und dem Wert true in deleted.

Fehler

  • Keine Sam AI-Datei mit dieser ID im Konto des Schlüssels.
  • Der Schlüssel eines Teammitglieds ändert einen Bereich, den seine Rolle nur ansehen darf. Der Schalter des X-Kontos und die Unterhaltungen liegen im Bereich Chat, Business-Infos und Dateien in den Einstellungen, Sam AI einer Persona im Bereich Personas.
DELETE/v1/conversations/:conversation_id/sam/files/:file_id
curl -X DELETE \
  https://gemlead.ai/api/v1/conversations/msgOtJ8dvT/sam/files/sf_4c1e9a07d2b35f68e190 \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"
Antwort200
{
  "id": "sf_4c1e9a07d2b35f68e190",
  "object": "sam_file",
  "deleted": true
}