Menu

Referência da API · Brand Voice

Documentos

social_brand_voice · documents · 3 operações

GET/v1/social-brand-voice/documents

List the brand voice documents

social_brand_voice.documents.list

LeituraIdempotenteDesde 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.

Escopo
social_brand_voice:read
Permissão
Ver o módulo
Tool do MCP
social_brand_voice_documents_listNa superfície completa; na compacta, mb_execute_operation com id: "social_brand_voice.documents.list".

Custo declarado: até 12 leituras e 0 escritas por chamada (contam na cota diária).

Parâmetros

limitintegerqueryopcional

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

Padrão: 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

Resposta

dataarray<object>
has_moreboolean
next_cursorstring

Erros

Exemplo

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

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode 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

LeituraIdempotenteDesde 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.

Escopo
social_brand_voice:read
Permissão
Ver o módulo
Tool do MCP
social_brand_voice_documents_getNa superfície completa; na compacta, mb_execute_operation com id: "social_brand_voice.documents.get".

Custo declarado: até 2 leituras e 0 escritas por chamada (contam na cota diária).

Parâmetros

document_idstringrotaobrigatório

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

Resposta

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).

Erros

Exemplo

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

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode 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

IrreversívelDesde 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.

Pede confirmação: primeiro dry_run: true (prévia e confirm_token, válido por 10 minutos e por uma única execução), depois o mesmo corpo com confirm_token. Em algumas poucas, só com certos dados: a descrição diz quando. Por que e como: Prévia e confirmação.

Escopo
social_brand_voice:write e «Permitir exclusões» (social_brand_voice:delete no OAuth)
Permissão
Editar no módulo
Tool do MCP
social_brand_voice_documents_deleteNa superfície completa; na compacta, mb_execute_operation com id: "social_brand_voice.documents.delete".

Custo declarado: até 45 leituras e 45 escritas por chamada (contam na cota diária).

Parâmetros

document_idstringrotaobrigatório

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

Resposta

oktrue
chunks_deletednumber

Erros

Exemplo

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
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode 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
}'