# Atualizar um briefing de pesquisa com citações URL canônica: https://sosoapi.ai/pt-br/docs/api/research-api-briefs-update Contrato: sha256:ab393e91e9b7f18a Substituir um briefing do Research com expected_revision e mutation_id; edições desatualizadas geram conflito. Exige agent:research. POST /research-api/briefs/update ## Autenticação e permissões - **Classes de credenciais aceitas:** user_session, delegated_oauth, personal_access_token - **Capacidade delegada:** agent:research - **Função mínima no workspace:** editor - **Escopo de acesso:** Recursos que este usuário tem autorização para acessar - **Consentimento para todos os workspaces obrigatório:** Não - **Altera o estado:** Sim - **Quando a operação estiver concluída:** versão confirmada de recurso do Research; nenhuma ação no provedor Um token só pode usar os direitos do seu proprietário. Cada requisição verifica participação no workspace, propriedade de recursos, workspaces selecionados e capacidades concedidas. Os perfis core e full mudam as ferramentas exibidas; não concedem acesso. ## Campos da requisição ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "mutation_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expected_revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "content": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "summary": { "type": "string", "maxLength": 10000 }, "findings": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "statement": { "type": "string", "minLength": 1, "maxLength": 4000 }, "basis": { "type": "string", "enum": [ "observed", "inferred", "generated" ] }, "evidence": { "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "evidence_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "evidence_id", "revision" ], "additionalProperties": false } }, "uncertainty": { "type": "string", "maxLength": 1000 } }, "required": [ "id", "statement", "basis", "evidence", "uncertainty" ], "additionalProperties": false } }, "angles": { "maxItems": 30, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "notes": { "type": "string", "maxLength": 10000 }, "project_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "project_revision": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "corpus_snapshot_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "language": { "type": "string", "minLength": 1, "maxLength": 35 } }, "required": [ "title", "question", "summary", "findings", "angles", "notes", "project_id", "project_revision", "corpus_snapshot_id", "language" ], "additionalProperties": false } }, "required": [ "workspace_id", "mutation_id", "id", "expected_revision", "content" ], "additionalProperties": false } ``` ## Resposta e conclusão Códigos HTTP de sucesso: 200 Uma resposta HTTP bem-sucedida pode significar que uma requisição foi aceita, não concluída. Para trabalho em segundo plano, salve o ID retornado e consulte a mesma operação até terminar. Um post agendado ou aceito só está publicado quando a plataforma confirma; um timeout do cliente não comprova o resultado. ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "brief": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workspace_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "archived": { "type": "boolean" }, "created_at": { "type": "string", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "format": "date-time" }, "updated_at": { "type": "string", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "format": "date-time" }, "content": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "summary": { "type": "string", "maxLength": 10000 }, "findings": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "statement": { "type": "string", "minLength": 1, "maxLength": 4000 }, "basis": { "type": "string", "enum": [ "observed", "inferred", "generated" ] }, "evidence": { "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "evidence_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "evidence_id", "revision" ] } }, "uncertainty": { "type": "string", "maxLength": 1000 } }, "required": [ "id", "statement", "basis", "evidence", "uncertainty" ] } }, "angles": { "maxItems": 30, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "notes": { "type": "string", "maxLength": 10000 }, "project_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "project_revision": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "corpus_snapshot_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "language": { "type": "string", "minLength": 1, "maxLength": 35 } }, "required": [ "title", "question", "summary", "findings", "angles", "notes", "project_id", "project_revision", "corpus_snapshot_id", "language" ] }, "reviewed_revision": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "id", "workspace_id", "revision", "archived", "created_at", "updated_at", "content", "reviewed_revision" ] } }, "required": [ "brief" ] } ``` ## Erros e repetições seguras Confira o status HTTP e o corpo da resposta. Um erro de validação 400 pode conter ZodError; erros do handler usam os campos error, message e code. Guarde request_id ou x-request-id para diagnóstico, sem credenciais. Corrija erros de acesso 401/403 antes de tentar novamente e siga Retry-After para 429. Se uma gravação for incerta ou retornar 5xx, consulte primeiro o resultado existente. Reutilize uma chave de idempotência somente quando houver suporte; o comportamento de repetição varia por operação e não garante entrega exatamente uma vez. ## Exemplos Estes exemplos usam valores fictícios verificados conforme os schemas. Substitua os IDs por aqueles que você tem autorização para usar, a mídia por ativos prontos e as datas pelo horário de publicação confirmado. Confira a elegibilidade da conta antes de enviar uma gravação. Esta página não envia requisições de API. Defina SOSOAPI_ACCESS_TOKEN no servidor como uma credencial aceita por esta operação e mantenha-a fora do código do navegador. Para agentes de IA, use sosoapi auth login para entrar pelo navegador e deixe a CLI renovar suas credenciais. request.json ```json { "workspace_id": "11111111-1111-4111-8111-111111111111", "mutation_id": "11111111-1111-4111-8111-111111111111", "id": "11111111-1111-4111-8111-111111111111", "expected_revision": 1, "content": { "title": "example", "question": "example", "summary": "example", "findings": [], "angles": [], "notes": "example", "project_id": null, "project_revision": null, "corpus_snapshot_id": null, "language": "example" } } ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/briefs/update" \ -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \ -H "Content-Type: application/json" \ --data-binary @request.json ``` JavaScript ```js // Server-side JavaScript. Do not print tokens or credential-bearing responses. const token = process.env.SOSOAPI_ACCESS_TOKEN; if (!token) throw new Error("Set an accepted credential for this operation"); const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/briefs/update", { method: "POST", headers: { "Content-Type": "application/json", Authorization: "Bearer " + token }, body: JSON.stringify({ "workspace_id": "11111111-1111-4111-8111-111111111111", "mutation_id": "11111111-1111-4111-8111-111111111111", "id": "11111111-1111-4111-8111-111111111111", "expected_revision": 1, "content": { "title": "example", "question": "example", "summary": "example", "findings": [], "angles": [], "notes": "example", "project_id": null, "project_revision": null, "corpus_snapshot_id": null, "language": "example" } }) }); const result = await response.json(); // Check response.ok, the operation-specific body and completion state before continuing. ``` CLI ```bash npx sosoapi api post /research-api/briefs/update < request.json ``` Exemplo de resposta sintética ```json { "brief": { "id": "11111111-1111-4111-8111-111111111111", "workspace_id": "11111111-1111-4111-8111-111111111111", "revision": 1, "archived": false, "created_at": "2099-01-15T09:00:00Z", "updated_at": "2099-01-15T09:00:00Z", "content": { "title": "example", "question": "example", "summary": "example", "findings": [], "angles": [], "notes": "example", "project_id": null, "project_revision": null, "corpus_snapshot_id": null, "language": "example" }, "reviewed_revision": null } } ``` ## Ferramentas e guias relacionados MCP: sosoapi_research_briefs_update [Referência da API](https://sosoapi.ai/pt-br/docs/api)