Producto
CLI

Archivos del agente

Gestiona los archivos de la base de conocimiento de un agente.

Base de conocimiento

Gestiona los archivos (PDF, DOC, DOCX) que el agente usa como base de conocimiento: listar, agregar desde una URL pública, revisar el estado de procesamiento y eliminar.

bash
01plazbot agent files <list|add|status|delete> [args] [options]

files list

Lista los archivos de la base de conocimiento de un agente.

bash
01plazbot agent files list <agentId> [options]

Parámetros

ParámetroFlagRequeridoDescripción
agentId(posicional)SíID del agente.
JSON--jsonNoImprime los archivos como un arreglo JSON (fileId, name, tags). Por defecto: false.

Ejemplos

bash
01# Listar los archivos de un agente
02plazbot agent files list age_AbcDef123
03 
04# Obtener los archivos en JSON
05plazbot agent files list age_AbcDef123 --json

Resultado

text
01 Files - Sales Plazbot
02 ────────────────────────────────────────
03┌───────────────┬─────────┬──────────────────┐
04│ ID │ Name │ Tags │
05├───────────────┼─────────┼──────────────────┤
06│ fil_AbcDef123 │ manual │ docs, onboarding │
07├───────────────┼─────────┼──────────────────┤
08│ fil_XyzUvw456 │ precios │ sales, 2026 │
09└───────────────┴─────────┴──────────────────┘

Sin archivos: No files in the knowledge base. y la sugerencia Add one with: plazbot agent files add age_AbcDef123 -u <url>.

Salida JSON

json
01[
02 { "fileId": "fil_AbcDef123", "name": "manual", "tags": ["docs", "onboarding"] }
03]

files add

Agrega un archivo remoto a la base de conocimiento. La URL debe ser pública. El procesamiento es asíncrono: revisa el estado con files status.

bash
01plazbot agent files add <agentId> -u <url> [options]

Parámetros

ParámetroFlagRequeridoDescripción
agentId(posicional)SíID del agente.
URL-u, --url <url>SíURL pública http(s) del archivo (PDF, DOC, DOCX).
Referencia-r, --reference <name>NoNombre de referencia en la base de conocimiento. Por defecto: el nombre del archivo sin extensión.
Etiquetas-t, --tags <tags>NoEtiquetas separadas por comas, por ejemplo docs,onboarding. Por defecto: ninguna.
JSON--jsonNoImprime el resultado como JSON ({"fileId","agentId","reference","status"}). Por defecto: false.

Ejemplos

bash
01# Agregar un manual en PDF
02plazbot agent files add age_AbcDef123 -u https://files.example.com/manual.pdf
03 
04# Agregar un archivo con referencia y etiquetas
05plazbot agent files add age_AbcDef123 -u https://files.example.com/precios.docx -r precios -t sales,2026

Resultado

text
01✔ File added
02 Reference: manual
03 File ID: fil_AbcDef123
04 The file is being processed. Check the status with:
05 plazbot agent files status fil_AbcDef123

Si la extensión no es PDF, DOC ni DOCX, se muestra un aviso (The file extension ".xlsx" may not be supported (expected PDF, DOC or DOCX).) y el archivo se envía igual.

Salida JSON

json
01{ "fileId": "fil_AbcDef123", "agentId": "age_AbcDef123", "reference": "manual", "status": "processing" }

files status

Revisa si un archivo terminó de procesarse.

bash
01plazbot agent files status <fileId> [options]

Parámetros

ParámetroFlagRequeridoDescripción
fileId(posicional)SíID del archivo (de files add o files list).
JSON--jsonNoImprime el estado como JSON ({"fileId","status"}). Por defecto: false.

Ejemplos

bash
01# Revisar un archivo
02plazbot agent files status fil_AbcDef123
03 
04# Revisar un archivo en JSON
05plazbot agent files status fil_AbcDef123 --json

Resultado

text
01 File status
02 ────────────────────────────────────────
03 File ID: fil_AbcDef123
04 Status: Completed

El estado es Completed o Processing.

Salida JSON

json
01{ "fileId": "fil_AbcDef123", "status": "completed" }

status es completed o processing.

files delete

Elimina un archivo de la base de conocimiento. Pide confirmación antes de borrar.

bash
01plazbot agent files delete <agentId> <fileId> [options]

Parámetros

ParámetroFlagRequeridoDescripción
agentId(posicional)SíID del agente.
fileId(posicional)SíID del archivo.
JSON--jsonNoImprime el resultado como JSON ({"agentId","fileId","deleted"}). Por defecto: false.
Confirmar-y, --yesNoOmite la confirmación (scripts y CI). Alias: --confirm. Por defecto: false.

Ejemplos

bash
01# Eliminar un archivo (pide confirmación)
02plazbot agent files delete age_AbcDef123 fil_AbcDef123
03 
04# Eliminar sin preguntar (scripts y CI)
05plazbot agent files delete age_AbcDef123 fil_AbcDef123 --yes

Resultado

text
01? Delete file fil_AbcDef123 from agent age_AbcDef123? This cannot be undone. (y/N) y
02✔ File deleted

Si respondes que no, se imprime Aborted. y el comando termina con código 1.

Salida JSON

json
01{ "agentId": "age_AbcDef123", "fileId": "fil_AbcDef123", "deleted": true }

Errores comunes

MensajeCausaSolución
error: required option '-u, --url <url>' not specifiedfiles add sin -u.Pasa la URL con -u.
Invalid URL "<valor>".La URL no es válida.Usa un enlace público, por ejemplo -u https://files.example.com/manual.pdf.
The file URL must start with http:// or https://.Protocolo distinto de http o https.Usa una URL http(s).
The API rejected the file.La API no aceptó el archivo.Revisa que la URL sea pública y el formato sea PDF, DOC o DOCX.
This action needs confirmation and there is no interactive terminal.files delete sin terminal (o con --json) y sin --yes.Agrega --yes.
You are not signed in.No hay sesión activa.Ejecuta plazbot login.
¿Quieres probar la API en vivo? Abre el Playground.