VolundOS
Referência da APIAgentes do app

Encerrar o chat embutido do app

Revoga uma sessão criada por `POST /v1/apps/me/embed-sessions`, só do mesmo app e da mesma pessoa do token. O iframe recebe a sessão encerrada no pedido seguinte. Idempotente: 204 também quando já estava encerrada. Exige o escopo runs:execute.

Atualizado em 04 de novembro de 2026
DELETE
/v1/apps/me/embed-sessions/{sessionId}

Authorization

chaveDeApi
AuthorizationBearer <token>

Chave de API da organização, criada nas configurações. Envie-a em Authorization: Bearer <sua chave>.

In: header

Path Parameters

sessionId*string

Id da sessão devolvido na criação.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/apps/me/embed-sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty

Abrir o chat embutido para a pessoa logada no app

Cria a sessão do chat embutido de um agente que o app oferece, para a pessoa logada nele, e devolve o `embed_url` para o `src` do iframe. A conversa roda como a PRÓPRIA pessoa (membro da organização), no canal `app`: o MCP do app funciona em modo delegado, valem as ferramentas e a cota dela, e a conversa aparece no VolundOS. O que o iframe não decide (aprovação de ferramenta, cofre) a pessoa decide lá. Responde ao token que o app obtém pela troca (`urn:ietf:params:oauth:grant-type:token-exchange`) em nome da pessoa: quem é o app e quem é a pessoa saem do token. Uma chave de API não representa um app e recebe 403. O corpo é opcional; `agent` é o apelido do agente no app (ausente, o padrão). Campo fora da lista responde 400 `invalid_request`: não há `user`, `restrictions`, `mcp` nem `context`, que são do chat embutido de aplicação vinculada. Exige o escopo runs:execute.

Ler o ranking de consumo da organização da chave

O lado servidor do Leaderboard multi-org: a organização que emitiu esta chave expõe por aqui o próprio ranking de consumo, para que outra organização possa incluí-lo no painel dela. Não há parâmetro de organização: a chave pertence a uma, e é dela que se fala. O ranking é lido com a permissão de QUEM EMITIU a chave — o que sai daqui é o que essa pessoa vê no próprio painel, nem mais nem menos. Responde 404 quando a organização desligou o leaderboard em Configurações: a decisão vale para os dados, e não só para a tela. Exige o escopo leaderboard:read.