Menú

Referencia de la API · Brand Voice

Documentos

social_brand_voice · documents · 3 operaciones

GET/v1/social-brand-voice/documents

List the brand voice documents

social_brand_voice.documents.list

LecturaIdempotenteDesde 2026-11-01

Lists the documents uploaded to Brand Voice (brand guides, style manuals, example copy; at most 5 per organization), 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), who uploaded it and when. MB Suite extracts their text and indexes it so Content Studio and the inbox write in the brand's voice. status is applied reading on until the page is full (up to 400 read per call). The extracted text comes with social_brand_voice.documents.get. Files are uploaded from the Brand Voice screen. Requires view access to Brand Voice.

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

Costo declarado: hasta 12 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/social-brand-voice/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/social-brand-voice/documents" \
  -H "Authorization: Bearer $MB_TEST_KEY"
GET/v1/social-brand-voice/documents/{document_id}

Get one brand voice document with its text

social_brand_voice.documents.get

LecturaIdempotenteDesde 2026-11-01

Returns one Brand Voice document 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 to write in the brand's voice. Not found (brand_voice_document_not_found) when the id does not exist or is one of the organization profile's general documents. The file itself is downloaded from the screen. Requires view access to Brand Voice.

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

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

Parámetros

document_idstringrutarequerido

Id of a Brand Voice document (from social_brand_voice.documents.list).

Respuesta

idstring
file_namestring
mime_typestring
size_bytesnumber
statusenum

Valores: processing, ready, error

uploaded_bystring

Who uploaded it (a user id).

uploaded_atnumber

When it was uploaded (epoch ms).

updated_atnumber
error_messagestring
embedding_statusenum

Valores: pending, processing, ready, error

embedding_errorstring
chunk_countnumber

Fragments indexed for the AI (retrieval).

uploaded_by_namestring

Their name.

extracted_textstring

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

Errores

Ejemplo

curl "https://api.mb-suite.com/v1/social-brand-voice/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/social-brand-voice/documents/{document_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"
DELETE/v1/social-brand-voice/documents/{document_id}

Delete a brand voice document

social_brand_voice.documents.delete

IrreversibleDesde 2026-11-01

Deletes a Brand Voice document for good: the file, its extracted text and its AI fragments, so it stops feeding Content Studio and the inbox. The organization profile's general documents are not reachable here. 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. Returns how many fragments were removed. Requires edit access to Brand Voice.

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
social_brand_voice:write y «Permitir eliminar» (social_brand_voice:delete en OAuth)
Permiso
Editar en el módulo
Tool del MCP
social_brand_voice_documents_deleteEn la superficie completa; en la compacta, mb_execute_operation con id: "social_brand_voice.documents.delete".

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

Parámetros

document_idstringrutarequerido

Id of a Brand Voice document (from social_brand_voice.documents.list).

Respuesta

oktrue
chunks_deletednumber

Errores

Ejemplo

curl -X DELETE "https://api.mb-suite.com/v1/social-brand-voice/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/social-brand-voice/documents/{document_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'