Workspaces

Um workspace é o tenant ao qual uma inbox pertence. Seis tools; as de escrita são restritas a tokens de sistema, porque um workspace é provisionado pelo sistema de origem, não por um usuário final.

Veja o modelo Workspace para o formato do objeto retornado.

---

workspaces_list

Leitura · escopo inbox/workspaces · permissão workspaces.list · GET /workspaces

Lista os workspaces da organização do token. Paginado por cursor; retorna { data, meta: { next_cursor } }.

Parâmetro	Tipo	Descrição
cursor	string	Cursor opaco de uma página anterior.
limit	integer	Tamanho da página, padrão 25, máximo 100.
sort	string	Chaves de ordenação, prefixo - para descendente.
source	string	Filtra pelo sistema de origem, p.ex. kobana_app.
slug	string	Filtra por slug.
external_id	string	Filtra pelo id no sistema de origem.
created_at_gte	string	created_at a partir deste timestamp ISO 8601.
created_at_lte	string	created_at até este timestamp ISO 8601.

workspaces_get

Leitura · escopo inbox/workspaces · permissão workspaces.show · GET /workspaces/{id}

Busca um workspace por id interno ou external_id.

Parâmetro	Tipo	Descrição
id obrigatório	string	Id interno ou external_id.

workspaces_create

Escrita · escopo inbox/workspaces + write · permissão workspaces.create · POST /workspaces

Cria um workspace. Exige um token src=system.

Parâmetro	Tipo	Descrição
label obrigatório	string	Nome de exibição, 1–120 caracteres.
external_id	string	Id do registro no sistema de origem.
source	string	Sistema de origem, p.ex. kobana_app.
slug	string	Minúsculo, com hífens. Vira um segmento do endereço de cada inbox.
monthly_cost_limit	number | null	Teto mensal de custo de LLM.
monthly_emails_limit	integer | null	Teto mensal de e-mails processados.
custom_metadata	object	JSON livre, de quem chama.
idempotency_key	string	Proteção contra replay, 8–255 caracteres.

workspaces_upsert

Escrita · escopo inbox/workspaces + write · permissão workspaces.create · PUT /workspaces

Cria ou atualiza um workspace, casado por id e depois external_id. Responde 200 quando atualiza e 201 quando cria. Exige um token src=system.

Parâmetro	Tipo	Descrição
id	string (uuid)	Casa primeiro pelo id interno.
label	string	Nome de exibição, 1–120 caracteres.
external_id	string	Chave de casamento no sistema de origem.
source	string	Sistema de origem.
slug	string	Minúsculo, com hífens.
monthly_cost_limit	number | null	Teto mensal de custo.
monthly_emails_limit	integer | null	Teto mensal de e-mails.
custom_metadata	object	JSON livre.
idempotency_key	string	Proteção contra replay.

workspaces_update

Escrita · escopo inbox/workspaces + write · permissão workspaces.update · PATCH /workspaces/{id}

Atualiza um workspace no lugar. Alterar os limites exige um token src=system.

Parâmetro	Tipo	Descrição
id obrigatório	string	Id interno ou external_id.
label	string	Nome de exibição, 1–120 caracteres.
external_id	string	Id no sistema de origem.
source	string	Sistema de origem.
slug	string	Minúsculo, com hífens.
monthly_cost_limit	number | null	Teto mensal de custo.
monthly_emails_limit	integer | null	Teto mensal de e-mails.
custom_metadata	object	JSON livre.

workspaces_delete

Destrutiva · escopo inbox/workspaces + write · permissão workspaces.delete · DELETE /workspaces/{id}

Exclui (soft-delete) um workspace. Exige um token src=system.

Parâmetro	Tipo	Descrição
id obrigatório	string	Id interno ou external_id.