Menú

Referencia de la API · Perfil

Documentos

profile · documents · 3 operaciones

GET/v1/profile/documents

List the organization's context documents

profile.documents.list

LecturaIdempotenteDesde 2026-11-01

Lists the organization's context documents (Settings → Profile: presentations, price lists, briefs that MB Suite's AI reads as context about the organization; at most 20 per organization, counted together with Brand Voice's), newest first, paginated by cursor: file name, MIME type, size, processing status (processing, ready, or error with error_message), the AI indexing status (embedding_status, chunk_count; read but not indexed for lack of AI credits is status ready with embedding_status error and embedding_error ai_credits_exhausted, ai_personal_limit or payment_required), the AI summary of older uploads when there is one, who uploaded it and when. Brand Voice's documents are not listed here (social_brand_voice.documents.list). status filters the page read and Brand Voice's documents are dropped from it, so a page can bring fewer than limit while has_more is true: follow next_cursor. The text comes with profile.documents.get. Files are uploaded from the screen. Requires view access to the Profile module.

Alcance
profile:read
Permiso
Ver el módulo
Tool del MCP
profile_documents_listEn la superficie completa; en la compacta, mb_execute_operation con id: "profile.documents.list".

Costo declarado: hasta 202 lecturas y 0 escrituras por llamada (cuentan en el cupo diario).

Parámetros

limitintegerqueryopcional

How many items this page brings at most (see the maximum and the default in the schema).

Por defecto: 50

cursorstringqueryopcional

The next_cursor of the previous page, exactly as it came (only for the same list and filters); without it, the first page.

statusenumqueryopcional

Only documents in this processing status (filtered on the page read).

Valores: processing, ready, error

Respuesta

dataarray<object>
has_moreboolean
next_cursorstring

Errores

Ejemplo

curl "https://api.mb-suite.com/v1/profile/documents" \
  -H "Authorization: Bearer $MB_API_KEY"

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl "https://api.mb-suite.com/v1/profile/documents" \
  -H "Authorization: Bearer $MB_TEST_KEY"
GET/v1/profile/documents/{document_id}

Get one context document with its text

profile.documents.get

LecturaIdempotenteDesde 2026-11-01

Returns one context document of the organization profile with the text MB Suite extracted from it (extracted_text, up to 50,000 characters; empty while it is processing or when extraction failed): the text the AI reads as context about the organization. Not found (context_document_not_found) when the id does not exist or is a Brand Voice document. The file itself is downloaded from the screen. Requires view access to the Profile module.

Alcance
profile:read
Permiso
Ver el módulo
Tool del MCP
profile_documents_getEn la superficie completa; en la compacta, mb_execute_operation con id: "profile.documents.get".

Costo declarado: hasta 1 lecturas y 0 escrituras por llamada (cuentan en el cupo diario).

Parámetros

document_idstringrutarequerido

Id of a context document (from profile.documents.list).

Respuesta

idstring
file_namestring
mime_typestring
size_bytesnumber
statusenum

Valores: processing, ready, error

uploaded_bystring
uploaded_atnumber
updated_atnumber
error_messagestring
embedding_statusenum

Valores: pending, processing, ready, error

embedding_errorstring
chunk_countnumber

Fragments indexed for the AI (retrieval).

summarystring

Short AI summary kept from older uploads (new documents have none).

extracted_textstring

Text extracted from the file (only in profile.documents.get).

Errores

Ejemplo

curl "https://api.mb-suite.com/v1/profile/documents/{document_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl "https://api.mb-suite.com/v1/profile/documents/{document_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"
DELETE/v1/profile/documents/{document_id}

Delete a context document

profile.documents.delete

IrreversibleDesde 2026-11-01

Deletes a context document of the organization profile for good: the file, its extracted text and its AI fragments, so MB Suite's AI stops using it. Brand Voice's documents are not reachable here (social_brand_voice.documents.delete). It does not go to the trash and cannot be undone: outside the screen it always needs a dry run (which says how many AI fragments go) and its confirm_token, and a credential allowed to delete. Returns how many fragments were removed. Requires edit access to the Profile module.

Pide confirmación: primero dry_run: true (vista previa y confirm_token, que vale 10 minutos y una sola vez), después el mismo cuerpo con confirm_token. En unas pocas, solo con ciertos datos: la descripción dice cuándo. Por qué y cómo: Vista previa y confirmación.

Alcance
profile:write y «Permitir eliminar» (profile:delete en OAuth)
Permiso
Editar en el módulo
Tool del MCP
profile_documents_deleteEn la superficie completa; en la compacta, mb_execute_operation con id: "profile.documents.delete".

Costo declarado: hasta 45 lecturas y 45 escrituras por llamada (cuentan en el cupo diario).

Parámetros

document_idstringrutarequerido

Id of a context document (from profile.documents.list).

Respuesta

oktrue
chunks_deletednumber

Errores

Ejemplo

curl -X DELETE "https://api.mb-suite.com/v1/profile/documents/{document_id}" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'

Probar con tu API key de prueba

Con una API key de prueba el pedido va siempre a tu organización de práctica: datos de ejemplo que puedes reiniciar.

curl -X DELETE "https://api.mb-suite.com/v1/profile/documents/{document_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'