API-referentie

Sam AI

Sam AI schrijft je antwoorden in de gesprekken van je campagnes. Hij leest instructies en bestanden op drie niveaus, het X-account voor je business, de persona voor hoe je aan dat type koper verkoopt, en het gesprek voor deze ene lead. Spreken twee niveaus elkaar tegen, dan wint het meest specifieke.

Een gesprek draait in een van drie modi. off laat het aan jou over. draft is Semi-automatisch, Sam AI schrijft een suggestie en jij verstuurt die. auto laat Sam AI zijn antwoorden zelf versturen vanaf je X-account. Een persona bepaalt de modus van de bijbehorende gesprekken, en een gesprek kan een eigen modus krijgen of met inherit die van de persona volgen.

Sam AI werkt met de abonnementen Business en Enterprise, en alleen in lopende campagnes. Onder Business schrijft hij niets, in draft noch in auto. Een antwoord van Sam AI kost 30 credits zodra het verstuurd wordt, hoeveel berichten het ook bevat. Een suggestie die je niet verstuurt is gratis, maar Sam AI schrijft er alleen een als je saldo een antwoord dekt. Nieuwe suggesties, de antwoorden die Sam AI verstuurt en de gesprekken die hij aan jou overdraagt, komen ook binnen via de webhooks sam.suggestion.ready, sam.reply.sent en sam.handoff.

Het Sam AI-object van het account

Sam AI op het hele X-account, de schakelaar en wat hij over je business weet.

Attributen

  • objectstring
    Altijd account_sam.
  • account_idstring
    De ID van het X-account, zoals in het accountobject.
  • enabledboolean
    false als Sam AI uit staat in alle gesprekken van het X-account, ongeacht hun modus.
  • instructionsstring
    Informatie over je business, die Sam AI in elk gesprek leest, zoals je aanbod, je prijzen, je garantie en je links. Maximaal 3 000 tekens.
  • filesarray van objects
    De bestanden die Sam AI in elk gesprek leest, als Sam AI-bestandsobjecten.
Het Sam AI-object van het account
{
  "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 van het account ophalen

GET/v1/account/samScope readMCPget_sam_settings

Geeft terug of Sam AI aan staat voor het X-account, met de informatie over je business en de bestanden.

Resultaat

Het Sam AI-object van het account.

GET/v1/account/sam
curl https://gemlead.ai/api/v1/account/sam \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"
Response200
{
  "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 van het account bijwerken

PATCH/v1/account/samScope writeMCPupdate_sam_settings

Zet Sam AI aan of uit voor het hele X-account, of wijzigt de informatie over je business die elk gesprek leest. Alleen de velden die je meestuurt, veranderen.

Bodyparameters

  • enabledboolean
    false zet Sam AI uit in alle gesprekken van het X-account, true zet hem weer aan.
  • instructionsstring
    Informatie over je business, maximaal 3 000 tekens. Een lege string wist het.

Resultaat

Het bijgewerkte Sam AI-object van het account.

Fouten

  • Een parameter heeft een waarde die de API niet accepteert. param geeft aan welke.
  • De body bevat een veld dat dit endpoint niet accepteert.
  • De sleutel van een teamlid wijzigt een onderdeel dat zijn rol alleen mag bekijken. De schakelaar van het X-account en de gesprekken vallen onder chat, de informatie over je business en de bestanden onder instellingen, de Sam AI van een persona onder persona's.
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."
  }'
Response200
{
  "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"
    }
  ]
}

Het Sam AI-object van een persona

Sam AI op een persona, voor de gesprekken met de leads ervan.

Attributen

  • objectstring
    Altijd persona_sam.
  • persona_idstring
    De ID van de persona.
  • modestring
    De modus van de gesprekken van de persona die geen eigen modus hebben. off laat ze aan jou over, draft is Semi-automatisch, waarbij Sam AI voorstelt en jij verstuurt, auto laat Sam AI zelf versturen. draft tot je het wijzigt.
    offdraftauto
  • instructionsstring
    Hoe je schrijft en verkoopt aan dit type koper, de Instructies van de persona in de app. Maximaal 6 000 tekens.
  • filesarray van objects
    De bestanden die Sam AI leest in de gesprekken van de persona, als Sam AI-bestandsobjecten.
Het Sam AI-object van een 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 van een persona ophalen

GET/v1/personas/:persona_id/samScope readMCPget_sam_settings

Geeft de modus van Sam AI in de gesprekken van de persona terug, met de instructies en de bestanden.

Padparameters

  • persona_idstringVerplicht
    De ID van de persona.

Resultaat

Het Sam AI-object van de persona.

Fouten

GET/v1/personas/:persona_id/sam
curl https://gemlead.ai/api/v1/personas/lvWBPnytpS/sam \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"
Response200
{
  "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 van een persona bijwerken

PATCH/v1/personas/:persona_id/samScope writeMCPupdate_sam_settings

Wijzigt de modus van Sam AI in de gesprekken van de persona die geen eigen modus hebben, of de instructies van de persona. Alleen de velden die je meestuurt, veranderen. Met auto gaan antwoorden vanzelf de deur uit vanaf je X-account.

Padparameters

  • persona_idstringVerplicht
    De ID van de persona.

Bodyparameters

  • modestring
    De modus van Sam AI in de gesprekken van de persona.
    offdraftauto
  • instructionsstring
    Hoe je schrijft en verkoopt aan dit type koper, maximaal 6 000 tekens. Een lege string wist de pitch.

Resultaat

Het bijgewerkte Sam AI-object van de persona.

Fouten

  • Geen persona met deze ID op het account van de sleutel.
  • Een parameter heeft een waarde die de API niet accepteert. param geeft aan welke.
  • De body bevat een veld dat dit endpoint niet accepteert.
  • auto op een account met een lager abonnement dan Business.
  • De sleutel van een teamlid wijzigt een onderdeel dat zijn rol alleen mag bekijken. De schakelaar van het X-account en de gesprekken vallen onder chat, de informatie over je business en de bestanden onder instellingen, de Sam AI van een persona onder persona's.
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"
  }'
Response200
{
  "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": []
}

Het Sam AI-object van een gesprek

Sam AI in één gesprek, de modus, het antwoord dat hij klaar heeft staan en wat hij over deze lead weet.

Attributen

  • objectstring
    Altijd conversation_sam.
  • conversation_idstring
    De ID van het gesprek.
  • modestring
    De eigen modus van het gesprek, of inherit als het die van de persona volgt.
    offdraftautoinherit
  • effective_modestring
    De modus die echt geldt. off als Sam AI uit staat op het X-account, het gesprek in geen enkele lopende campagne zit of het account een lager abonnement dan Business heeft.
    offdraftauto
  • personaobject of null
    De persona die Sam AI leest, met id, name en mode.
  • campaignobject of null
    De campagne waarin het gesprek loopt, met id en name. Sam AI antwoordt alleen in een lopende campagne.
  • statusstring
    Wat Sam AI aan het doen is. writing als hij een antwoord schrijft, suggested als er een op jou wacht, scheduled als het vanzelf vertrekt op suggestion.send_at, sending, sent, no_reply als hij besloot niet te antwoorden, handoff als hij het gesprek aan jou overdraagt, no_credits als het saldo onder de 30 credits van een antwoord zit, off of idle.
    idlewritingsuggestedscheduledsendingsentno_replyhandoffno_creditsoff
  • reasonstring of null
    De reden bij no_reply en handoff, in de woorden van Sam AI.
  • suggestionobject of null
    Het antwoord dat Sam AI klaar heeft staan, zolang status op suggested, scheduled of sending staat.
  • instructionsstring
    Wat Sam AI over deze ene lead moet weten. Maximaal 3 000 tekens.
  • filesarray van objects
    De bestanden die Sam AI alleen in dit gesprek leest, als Sam AI-bestandsobjecten.
  • updated_atstring of null
    Wanneer de status van Sam AI voor het laatst veranderde, in ISO 8601.
Het Sam AI-object van een gesprek
{
  "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 van een gesprek ophalen

GET/v1/conversations/:conversation_id/samScope readMCPget_sam_settings

Geeft de modus van Sam AI in het gesprek terug en de modus die echt geldt, het antwoord dat hij klaar heeft staan, en de eigen instructies en bestanden van het gesprek.

Padparameters

  • conversation_idstringVerplicht
    De ID van het gesprek.

Resultaat

Het Sam AI-object van het gesprek.

Fouten

GET/v1/conversations/:conversation_id/sam
curl https://gemlead.ai/api/v1/conversations/msgOtJ8dvT/sam \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"
Response200
{
  "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 van een gesprek bijwerken

PATCH/v1/conversations/:conversation_id/samScope writeMCPupdate_sam_settings

Stelt de modus van Sam AI in voor dit ene gesprek, of laat het met inherit weer de persona volgen, of wijzigt wat Sam AI over deze lead weet. Alleen de velden die je meestuurt, veranderen. Met auto gaan antwoorden vanzelf de deur uit vanaf je X-account.

Padparameters

  • conversation_idstringVerplicht
    De ID van het gesprek.

Bodyparameters

  • modestring
    De modus van Sam AI in dit gesprek. inherit volgt die van de persona.
    offdraftautoinherit
  • instructionsstring
    Wat Sam AI over deze lead moet weten, maximaal 3 000 tekens. Een lege string wist het.

Resultaat

Het bijgewerkte Sam AI-object van het gesprek.

Fouten

  • Geen gesprek met deze ID op het account van de sleutel.
  • Een parameter heeft een waarde die de API niet accepteert. param geeft aan welke.
  • De body bevat een veld dat dit endpoint niet accepteert.
  • auto op een account met een lager abonnement dan Business.
  • De sleutel van een teamlid wijzigt een onderdeel dat zijn rol alleen mag bekijken. De schakelaar van het X-account en de gesprekken vallen onder chat, de informatie over je business en de bestanden onder instellingen, de Sam AI van een persona onder persona's.
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"
  }'
Response200
{
  "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"
}

Het Sam AI-bestandsobject

Een document dat Sam AI voor elk antwoord leest, een PDF-, DOCX-, TXT-, MD- of CSV-bestand. Elk niveau bevat maximaal 30 bestanden en 100 MB.

Attributen

  • idstring
    Unieke ID van het bestand op zijn niveau.
  • objectstring
    Altijd sam_file.
  • namestring
    De naam van het bestand, zoals de app die toont.
  • sizeinteger
    De grootte in bytes.
  • mime_typestring of null
    Het type, zoals application/pdf.
  • urlstring
    Waar Gemlead het bewaart.
Het Sam AI-bestandsobject
{
  "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"
}

Een bestand aan het account toevoegen

POST/v1/account/sam/filesScope writeMCPedit_sam_files

Geeft Sam AI een document om te lezen in elk gesprek van het X-account. Stuur de publieke URL of de bytes in base64. Gemlead leest het één keer, controleert of het een PDF-, DOCX-, TXT-, MD- of CSV-bestand is en bewaart een eigen kopie.

Bodyparameters

  • urlstring
    Het bestand op een publieke HTTPS-URL. Gemlead leest het één keer en bewaart een eigen kopie. Geef url of data.
  • datastring
    Het bestand, base64-gecodeerd, in plaats van url. Stuur een groot bestand als url.
  • namestring
    De naam die de app toont, maximaal 200 tekens. Verplicht bij data, anders het laatste deel van de URL. Gemlead voegt de extensie toe als die ontbreekt.

Resultaat

Het nieuwe Sam AI-bestandsobject.

Fouten

  • Er ontbreekt een verplichte parameter. param geeft aan welke.
  • Het bestand is geen PDF-, DOCX-, TXT-, MD- of CSV-bestand, is leeg of groter dan 25 MB, of de URL is niet leesbaar. param geeft aan welke.
  • De body bevat een veld dat dit endpoint niet accepteert.
  • Dit niveau bevat al 30 bestanden of 100 MB aan bestanden. Verwijder er eerst een.
  • Meer dan 100 bestanden in een uur op dit X-account.
  • De sleutel van een teamlid wijzigt een onderdeel dat zijn rol alleen mag bekijken. De schakelaar van het X-account en de gesprekken vallen onder chat, de informatie over je business en de bestanden onder instellingen, de Sam AI van een persona onder persona's.
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"
  }'
Response200
{
  "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"
}

Een bestand van het account verwijderen

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

Haalt een bestand van het niveau weg. Vanaf zijn volgende antwoord leest Sam AI het niet meer.

Padparameters

  • file_idstringVerplicht
    De ID van het Sam AI-bestand.

Resultaat

Een object met de id van het bestand en deleted op true.

Fouten

  • Geen Sam AI-bestand met deze ID op het account van de sleutel.
  • De sleutel van een teamlid wijzigt een onderdeel dat zijn rol alleen mag bekijken. De schakelaar van het X-account en de gesprekken vallen onder chat, de informatie over je business en de bestanden onder instellingen, de Sam AI van een persona onder persona's.
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"
Response200
{
  "id": "sf_4c1e9a07d2b35f68e190",
  "object": "sam_file",
  "deleted": true
}

Een bestand aan een persona toevoegen

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

Geeft Sam AI een document om te lezen in de gesprekken van de persona. Stuur de publieke URL of de bytes in base64. Gemlead leest het één keer, controleert of het een PDF-, DOCX-, TXT-, MD- of CSV-bestand is en bewaart een eigen kopie.

Padparameters

  • persona_idstringVerplicht
    De ID van de persona.

Bodyparameters

  • urlstring
    Het bestand op een publieke HTTPS-URL. Gemlead leest het één keer en bewaart een eigen kopie. Geef url of data.
  • datastring
    Het bestand, base64-gecodeerd, in plaats van url. Stuur een groot bestand als url.
  • namestring
    De naam die de app toont, maximaal 200 tekens. Verplicht bij data, anders het laatste deel van de URL. Gemlead voegt de extensie toe als die ontbreekt.

Resultaat

Het nieuwe Sam AI-bestandsobject.

Fouten

  • Geen persona met deze ID op het account van de sleutel.
  • Er ontbreekt een verplichte parameter. param geeft aan welke.
  • Het bestand is geen PDF-, DOCX-, TXT-, MD- of CSV-bestand, is leeg of groter dan 25 MB, of de URL is niet leesbaar. param geeft aan welke.
  • De body bevat een veld dat dit endpoint niet accepteert.
  • Dit niveau bevat al 30 bestanden of 100 MB aan bestanden. Verwijder er eerst een.
  • Meer dan 100 bestanden in een uur op dit X-account.
  • De sleutel van een teamlid wijzigt een onderdeel dat zijn rol alleen mag bekijken. De schakelaar van het X-account en de gesprekken vallen onder chat, de informatie over je business en de bestanden onder instellingen, de Sam AI van een persona onder persona's.
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"
  }'
Response200
{
  "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"
}

Een bestand van een persona verwijderen

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

Haalt een bestand van het niveau weg. Vanaf zijn volgende antwoord leest Sam AI het niet meer.

Padparameters

  • persona_idstringVerplicht
    De ID van de persona.
  • file_idstringVerplicht
    De ID van het Sam AI-bestand.

Resultaat

Een object met de id van het bestand en deleted op true.

Fouten

  • Geen Sam AI-bestand met deze ID op het account van de sleutel.
  • De sleutel van een teamlid wijzigt een onderdeel dat zijn rol alleen mag bekijken. De schakelaar van het X-account en de gesprekken vallen onder chat, de informatie over je business en de bestanden onder instellingen, de Sam AI van een persona onder persona's.
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"
Response200
{
  "id": "sf_4c1e9a07d2b35f68e190",
  "object": "sam_file",
  "deleted": true
}

Een bestand aan een gesprek toevoegen

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

Geeft Sam AI een document over deze ene lead. Stuur de publieke URL of de bytes in base64. Gemlead leest het één keer, controleert of het een PDF-, DOCX-, TXT-, MD- of CSV-bestand is en bewaart een eigen kopie.

Padparameters

  • conversation_idstringVerplicht
    De ID van het gesprek.

Bodyparameters

  • urlstring
    Het bestand op een publieke HTTPS-URL. Gemlead leest het één keer en bewaart een eigen kopie. Geef url of data.
  • datastring
    Het bestand, base64-gecodeerd, in plaats van url. Stuur een groot bestand als url.
  • namestring
    De naam die de app toont, maximaal 200 tekens. Verplicht bij data, anders het laatste deel van de URL. Gemlead voegt de extensie toe als die ontbreekt.

Resultaat

Het nieuwe Sam AI-bestandsobject.

Fouten

  • Geen gesprek met deze ID op het account van de sleutel.
  • Er ontbreekt een verplichte parameter. param geeft aan welke.
  • Het bestand is geen PDF-, DOCX-, TXT-, MD- of CSV-bestand, is leeg of groter dan 25 MB, of de URL is niet leesbaar. param geeft aan welke.
  • De body bevat een veld dat dit endpoint niet accepteert.
  • Dit niveau bevat al 30 bestanden of 100 MB aan bestanden. Verwijder er eerst een.
  • Meer dan 100 bestanden in een uur op dit X-account.
  • De sleutel van een teamlid wijzigt een onderdeel dat zijn rol alleen mag bekijken. De schakelaar van het X-account en de gesprekken vallen onder chat, de informatie over je business en de bestanden onder instellingen, de Sam AI van een persona onder persona's.
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"
  }'
Response200
{
  "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"
}

Een bestand van een gesprek verwijderen

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

Haalt een bestand van het niveau weg. Vanaf zijn volgende antwoord leest Sam AI het niet meer.

Padparameters

  • conversation_idstringVerplicht
    De ID van het gesprek.
  • file_idstringVerplicht
    De ID van het Sam AI-bestand.

Resultaat

Een object met de id van het bestand en deleted op true.

Fouten

  • Geen Sam AI-bestand met deze ID op het account van de sleutel.
  • De sleutel van een teamlid wijzigt een onderdeel dat zijn rol alleen mag bekijken. De schakelaar van het X-account en de gesprekken vallen onder chat, de informatie over je business en de bestanden onder instellingen, de Sam AI van een persona onder persona's.
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"
Response200
{
  "id": "sf_4c1e9a07d2b35f68e190",
  "object": "sam_file",
  "deleted": true
}