Riferimento API

Sam AI

Sam AI scrive le tue risposte nelle conversazioni delle campagne. Legge istruzioni e file su tre livelli, l'account X per il tuo business, la buyer persona per come vendere a quel tipo di acquirente e la conversazione per quel singolo lead. Quando due livelli non sono d'accordo, vince il più preciso.

Una conversazione funziona in una di tre modalità. off la lascia a te. draft è la modalità Semi-auto, Sam AI scrive un suggerimento e tu lo invii. auto lascia che Sam AI invii da solo le sue risposte dal tuo account X. Una buyer persona imposta la modalità delle sue conversazioni, e una conversazione può averne una propria oppure seguire con inherit quella della sua buyer persona.

Sam AI funziona con i piani Business ed Enterprise, e solo nelle campagne attive. Sotto Business non scrive nulla, né in draft né in auto. Una risposta di Sam AI usa 30 crediti quando parte, qualunque sia il numero di messaggi che contiene. Un suggerimento che non invii è gratis, ma Sam AI ne scrive uno solo se il tuo saldo copre una risposta. I nuovi suggerimenti, le risposte che Sam AI invia e le conversazioni che ti passa arrivano anche con i webhook sam.suggestion.ready, sam.reply.sent e sam.handoff.

L'oggetto Sam AI dell'account

Sam AI su tutto l'account X, il suo interruttore e ciò che sa del tuo business.

Attributi

  • objectstring
    Sempre account_sam.
  • account_idstring
    L'ID dell'account X, come nell'oggetto account.
  • enabledboolean
    false quando Sam AI è disattivato in tutte le conversazioni dell'account X, qualunque sia la loro modalità.
  • instructionsstring
    Cos'è il tuo business, letto in ogni conversazione, come la tua offerta, i tuoi prezzi, la tua garanzia e i tuoi link. Fino a 3 000 caratteri.
  • filesarray di objects
    I file che Sam AI legge in ogni conversazione, come oggetti file di Sam AI.
L'oggetto Sam AI dell'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"
    }
  ]
}

Recupera il Sam AI dell'account

GET/v1/account/samScope readMCPget_sam_settings

Indica se Sam AI è attivo per l'account X, con le informazioni sul business e i file.

Restituisce

L'oggetto Sam AI dell'account.

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

Aggiorna il Sam AI dell'account

PATCH/v1/account/samScope writeMCPupdate_sam_settings

Attiva o disattiva Sam AI per tutto l'account X, oppure modifica le informazioni sul business che ogni conversazione legge. Cambiano solo i campi che invii.

Parametri del body

  • enabledboolean
    false disattiva Sam AI in tutte le conversazioni dell'account X, true lo riattiva.
  • instructionsstring
    Cos'è il tuo business, fino a 3 000 caratteri. Una stringa vuota lo cancella.

Restituisce

L'oggetto Sam AI dell'account aggiornato.

Errori

  • Un parametro ha un valore che l'API non accetta. param lo indica.
  • Il body ha un campo che questo endpoint non accetta.
  • La chiave di un membro del team modifica un'area che il suo ruolo può solo vedere. L'interruttore dell'account X e le conversazioni sono nell'area chat, le informazioni sul business e i file nelle impostazioni, il Sam AI di una buyer persona nell'area buyer persona.
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."
  }'
Risposta200
{
  "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"
    }
  ]
}

L'oggetto Sam AI della buyer persona

Sam AI su una buyer persona, per le conversazioni con i suoi lead.

Attributi

  • objectstring
    Sempre persona_sam.
  • persona_idstring
    L'ID della buyer persona.
  • modestring
    La modalità delle conversazioni della buyer persona che non ne hanno una propria. off le lascia a te, draft è Semi-auto, Sam AI suggerisce e tu invii, auto lascia che Sam AI invii da solo. draft finché non la cambi.
    offdraftauto
  • instructionsstring
    Come scrivere e vendere a questo tipo di acquirente, le Istruzioni della buyer persona nell'app. Fino a 6 000 caratteri.
  • filesarray di objects
    I file che Sam AI legge nelle conversazioni della buyer persona, come oggetti file di Sam AI.
L'oggetto Sam AI della buyer 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": []
}

Recupera il Sam AI di una buyer persona

GET/v1/personas/:persona_id/samScope readMCPget_sam_settings

Restituisce la modalità di Sam AI per le conversazioni della buyer persona, le sue istruzioni e i suoi file.

Parametri di percorso

  • persona_idstringObbligatorio
    L'ID della buyer persona.

Restituisce

L'oggetto Sam AI della buyer persona.

Errori

  • Nessuna buyer persona con questo ID sull'account della chiave.
GET/v1/personas/:persona_id/sam
curl https://gemlead.ai/api/v1/personas/lvWBPnytpS/sam \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"
Risposta200
{
  "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": []
}

Aggiorna il Sam AI di una buyer persona

PATCH/v1/personas/:persona_id/samScope writeMCPupdate_sam_settings

Modifica la modalità di Sam AI nelle conversazioni della buyer persona che non ne hanno una propria, oppure le istruzioni della buyer persona. Cambiano solo i campi che invii. auto invia le risposte dal tuo account X in autonomia.

Parametri di percorso

  • persona_idstringObbligatorio
    L'ID della buyer persona.

Parametri del body

  • modestring
    La modalità di Sam AI nelle conversazioni della buyer persona.
    offdraftauto
  • instructionsstring
    Come scrivere e vendere a questo tipo di acquirente, fino a 6 000 caratteri. Una stringa vuota lo cancella.

Restituisce

L'oggetto Sam AI della buyer persona aggiornato.

Errori

  • Nessuna buyer persona con questo ID sull'account della chiave.
  • Un parametro ha un valore che l'API non accetta. param lo indica.
  • Il body ha un campo che questo endpoint non accetta.
  • auto su un account con un piano inferiore a Business.
  • La chiave di un membro del team modifica un'area che il suo ruolo può solo vedere. L'interruttore dell'account X e le conversazioni sono nell'area chat, le informazioni sul business e i file nelle impostazioni, il Sam AI di una buyer persona nell'area buyer persona.
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"
  }'
Risposta200
{
  "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": []
}

L'oggetto Sam AI della conversazione

Sam AI in una conversazione, la sua modalità, la risposta che ha pronta e ciò che sa di questo lead.

Attributi

  • objectstring
    Sempre conversation_sam.
  • conversation_idstring
    L'ID della conversazione.
  • modestring
    La modalità propria della conversazione, oppure inherit quando segue quella della sua buyer persona.
    offdraftautoinherit
  • effective_modestring
    La modalità effettivamente in uso. off quando Sam AI è disattivato sull'account X, la conversazione non è in nessuna campagna attiva o l'account ha un piano inferiore a Business.
    offdraftauto
  • personaobject o null
    La buyer persona che Sam AI legge, con id, name e mode.
  • campaignobject o null
    La campagna in cui si svolge la conversazione, con id e name. Sam AI risponde solo in una campagna attiva.
  • statusstring
    Cosa sta facendo Sam AI. writing mentre scrive una risposta, suggested quando una risposta ti aspetta, scheduled quando partirà da sola a suggestion.send_at, sending, sent, no_reply quando ha scelto di non rispondere, handoff quando ti passa la conversazione, no_credits quando il saldo è sotto i 30 crediti di una risposta, off o idle.
    idlewritingsuggestedscheduledsendingsentno_replyhandoffno_creditsoff
  • reasonstring o null
    Il motivo, per no_reply e handoff, come l'ha scritto Sam AI.
  • suggestionobject o null
    La risposta che Sam AI ha pronta, mentre status è suggested, scheduled o sending.
  • instructionsstring
    Cosa Sam AI deve sapere su questo lead in particolare. Fino a 3 000 caratteri.
  • filesarray di objects
    I file che Sam AI legge solo in questa conversazione, come oggetti file di Sam AI.
  • updated_atstring o null
    Quando è cambiato per l'ultima volta lo stato di Sam AI, ISO 8601.
L'oggetto Sam AI della conversazione
{
  "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"
}

Recupera il Sam AI di una conversazione

GET/v1/conversations/:conversation_id/samScope readMCPget_sam_settings

Restituisce la modalità di Sam AI nella conversazione e quella effettivamente in uso, la risposta che ha pronta, e le istruzioni e i file propri della conversazione.

Parametri di percorso

  • conversation_idstringObbligatorio
    L'ID della conversazione.

Restituisce

L'oggetto Sam AI della conversazione.

Errori

  • Nessuna conversazione con questo ID sull'account della chiave.
GET/v1/conversations/:conversation_id/sam
curl https://gemlead.ai/api/v1/conversations/msgOtJ8dvT/sam \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"
Risposta200
{
  "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"
}

Aggiorna il Sam AI di una conversazione

PATCH/v1/conversations/:conversation_id/samScope writeMCPupdate_sam_settings

Imposta la modalità di Sam AI solo in questa conversazione, oppure la riaffida alla sua buyer persona con inherit, oppure modifica ciò che Sam AI sa di questo lead. Cambiano solo i campi che invii. auto invia le risposte dal tuo account X in autonomia.

Parametri di percorso

  • conversation_idstringObbligatorio
    L'ID della conversazione.

Parametri del body

  • modestring
    La modalità di Sam AI in questa conversazione. inherit segue quella della buyer persona.
    offdraftautoinherit
  • instructionsstring
    Cosa Sam AI deve sapere su questo lead, fino a 3 000 caratteri. Una stringa vuota lo cancella.

Restituisce

L'oggetto Sam AI della conversazione aggiornato.

Errori

  • Nessuna conversazione con questo ID sull'account della chiave.
  • Un parametro ha un valore che l'API non accetta. param lo indica.
  • Il body ha un campo che questo endpoint non accetta.
  • auto su un account con un piano inferiore a Business.
  • La chiave di un membro del team modifica un'area che il suo ruolo può solo vedere. L'interruttore dell'account X e le conversazioni sono nell'area chat, le informazioni sul business e i file nelle impostazioni, il Sam AI di una buyer persona nell'area buyer persona.
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"
  }'
Risposta200
{
  "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"
}

L'oggetto file di Sam AI

Un documento che Sam AI legge prima di ogni risposta, un file PDF, DOCX, TXT, MD o CSV. Ogni livello contiene al massimo 30 file e 100 MB.

Attributi

  • idstring
    Identificatore univoco del file nel suo livello.
  • objectstring
    Sempre sam_file.
  • namestring
    Il nome del file, come lo mostra l'app.
  • sizeinteger
    La sua dimensione in byte.
  • mime_typestring o null
    Il suo tipo, come application/pdf.
  • urlstring
    Dove Gemlead lo conserva.
L'oggetto file di Sam AI
{
  "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"
}

Aggiungi un file all'account

POST/v1/account/sam/filesScope writeMCPedit_sam_files

Dà a Sam AI un documento da leggere in ogni conversazione dell'account X. Invia il suo URL pubblico o i suoi byte in base64. Gemlead lo legge una volta, verifica che sia un file PDF, DOCX, TXT, MD o CSV e ne conserva una copia propria.

Parametri del body

  • urlstring
    Il file a un URL HTTPS pubblico. Gemlead lo legge una volta e ne conserva una copia propria. Indica url o data.
  • datastring
    Il file, codificato in base64, al posto di url. Per un file grande usa url.
  • namestring
    Il nome che mostra l'app, fino a 200 caratteri. Obbligatorio con data, altrimenti l'ultima parte dell'URL. Gemlead aggiunge l'estensione quando manca.

Restituisce

Il nuovo oggetto file di Sam AI.

Errori

  • Manca un parametro obbligatorio. param lo indica.
  • Il file non è un PDF, DOCX, TXT, MD o CSV, è vuoto o supera i 25 MB, oppure il suo URL non si può leggere. param lo indica.
  • Il body ha un campo che questo endpoint non accetta.
  • Il livello contiene già 30 file o 100 MB di file. Eliminane prima uno.
  • Più di 100 file in un'ora su questo account X.
  • La chiave di un membro del team modifica un'area che il suo ruolo può solo vedere. L'interruttore dell'account X e le conversazioni sono nell'area chat, le informazioni sul business e i file nelle impostazioni, il Sam AI di una buyer persona nell'area buyer persona.
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"
  }'
Risposta200
{
  "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"
}

Elimina un file dell'account

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

Toglie un file dal livello. Sam AI smette di leggerlo dalla sua prossima risposta.

Parametri di percorso

  • file_idstringObbligatorio
    L'ID del file di Sam AI.

Restituisce

Un oggetto con l'id del file e deleted impostato su true.

Errori

  • Nessun file di Sam AI con questo ID sull'account della chiave.
  • La chiave di un membro del team modifica un'area che il suo ruolo può solo vedere. L'interruttore dell'account X e le conversazioni sono nell'area chat, le informazioni sul business e i file nelle impostazioni, il Sam AI di una buyer persona nell'area buyer persona.
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"
Risposta200
{
  "id": "sf_4c1e9a07d2b35f68e190",
  "object": "sam_file",
  "deleted": true
}

Aggiungi un file a una buyer persona

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

Dà a Sam AI un documento da leggere nelle conversazioni della buyer persona. Invia il suo URL pubblico o i suoi byte in base64. Gemlead lo legge una volta, verifica che sia un file PDF, DOCX, TXT, MD o CSV e ne conserva una copia propria.

Parametri di percorso

  • persona_idstringObbligatorio
    L'ID della buyer persona.

Parametri del body

  • urlstring
    Il file a un URL HTTPS pubblico. Gemlead lo legge una volta e ne conserva una copia propria. Indica url o data.
  • datastring
    Il file, codificato in base64, al posto di url. Per un file grande usa url.
  • namestring
    Il nome che mostra l'app, fino a 200 caratteri. Obbligatorio con data, altrimenti l'ultima parte dell'URL. Gemlead aggiunge l'estensione quando manca.

Restituisce

Il nuovo oggetto file di Sam AI.

Errori

  • Nessuna buyer persona con questo ID sull'account della chiave.
  • Manca un parametro obbligatorio. param lo indica.
  • Il file non è un PDF, DOCX, TXT, MD o CSV, è vuoto o supera i 25 MB, oppure il suo URL non si può leggere. param lo indica.
  • Il body ha un campo che questo endpoint non accetta.
  • Il livello contiene già 30 file o 100 MB di file. Eliminane prima uno.
  • Più di 100 file in un'ora su questo account X.
  • La chiave di un membro del team modifica un'area che il suo ruolo può solo vedere. L'interruttore dell'account X e le conversazioni sono nell'area chat, le informazioni sul business e i file nelle impostazioni, il Sam AI di una buyer persona nell'area buyer persona.
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"
  }'
Risposta200
{
  "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"
}

Elimina un file di una buyer persona

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

Toglie un file dal livello. Sam AI smette di leggerlo dalla sua prossima risposta.

Parametri di percorso

  • persona_idstringObbligatorio
    L'ID della buyer persona.
  • file_idstringObbligatorio
    L'ID del file di Sam AI.

Restituisce

Un oggetto con l'id del file e deleted impostato su true.

Errori

  • Nessun file di Sam AI con questo ID sull'account della chiave.
  • La chiave di un membro del team modifica un'area che il suo ruolo può solo vedere. L'interruttore dell'account X e le conversazioni sono nell'area chat, le informazioni sul business e i file nelle impostazioni, il Sam AI di una buyer persona nell'area buyer persona.
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"
Risposta200
{
  "id": "sf_4c1e9a07d2b35f68e190",
  "object": "sam_file",
  "deleted": true
}

Aggiungi un file a una conversazione

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

Dà a Sam AI un documento su questo lead in particolare. Invia il suo URL pubblico o i suoi byte in base64. Gemlead lo legge una volta, verifica che sia un file PDF, DOCX, TXT, MD o CSV e ne conserva una copia propria.

Parametri di percorso

  • conversation_idstringObbligatorio
    L'ID della conversazione.

Parametri del body

  • urlstring
    Il file a un URL HTTPS pubblico. Gemlead lo legge una volta e ne conserva una copia propria. Indica url o data.
  • datastring
    Il file, codificato in base64, al posto di url. Per un file grande usa url.
  • namestring
    Il nome che mostra l'app, fino a 200 caratteri. Obbligatorio con data, altrimenti l'ultima parte dell'URL. Gemlead aggiunge l'estensione quando manca.

Restituisce

Il nuovo oggetto file di Sam AI.

Errori

  • Nessuna conversazione con questo ID sull'account della chiave.
  • Manca un parametro obbligatorio. param lo indica.
  • Il file non è un PDF, DOCX, TXT, MD o CSV, è vuoto o supera i 25 MB, oppure il suo URL non si può leggere. param lo indica.
  • Il body ha un campo che questo endpoint non accetta.
  • Il livello contiene già 30 file o 100 MB di file. Eliminane prima uno.
  • Più di 100 file in un'ora su questo account X.
  • La chiave di un membro del team modifica un'area che il suo ruolo può solo vedere. L'interruttore dell'account X e le conversazioni sono nell'area chat, le informazioni sul business e i file nelle impostazioni, il Sam AI di una buyer persona nell'area buyer persona.
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"
  }'
Risposta200
{
  "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"
}

Elimina un file di una conversazione

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

Toglie un file dal livello. Sam AI smette di leggerlo dalla sua prossima risposta.

Parametri di percorso

  • conversation_idstringObbligatorio
    L'ID della conversazione.
  • file_idstringObbligatorio
    L'ID del file di Sam AI.

Restituisce

Un oggetto con l'id del file e deleted impostato su true.

Errori

  • Nessun file di Sam AI con questo ID sull'account della chiave.
  • La chiave di un membro del team modifica un'area che il suo ruolo può solo vedere. L'interruttore dell'account X e le conversazioni sono nell'area chat, le informazioni sul business e i file nelle impostazioni, il Sam AI di una buyer persona nell'area buyer persona.
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"
Risposta200
{
  "id": "sf_4c1e9a07d2b35f68e190",
  "object": "sam_file",
  "deleted": true
}