Pular para o conteúdo principal

kobana inbox agents

Comandos de kobana inbox agents. Toda opção global (Opções globais) vale aqui.

ComandoHTTPDescrição
agents listGET /v1/agentsListar agents
agents createPOST /v1/agentsCriar agent
agents updatePUT /v1/agentsCriar ou atualizar agente
agents getGET /v1/agents/{id}Obter agent
agents deleteDELETE /v1/agents/{id}Excluir agent
agents versionsGET /v1/agents/{id}/versionsListar versões do prompt do agente

agents list​

Listar agents

kobana inbox agents list [OPÇÕES]

GET /v1/agents

Paginação keyset. Filtros são query params tipados (campo=valor, campo[op]=valor); filtros desconhecidos, campos não ordenáveis e valores malformados são rejeitados com 400 VALIDATION_ERROR.

Parâmetros de consulta

NomeTipoObrigatórioDescrição
limitintegernão
cursorstringnãoCursor opaco retornado em meta.next_cursor da página anterior.
sort_bystringnãoCampo de ordenação. Permitidos: created_at, updated_at, label, version. Sem ele, a ordem é created_at decrescente. Valores: created_at, updated_at, label, version.
sort_orderstringnãoasc (padrão) ou desc. Exige sort_by. Valores: asc, desc.
llm_modelstringnãoIgualdade. Também llm_model[in]=a,b.
external_idstringnãoIgualdade. Também external_id[in]=a,b.
created_atstringnãoIgualdade. Também created_at[in]=a,b e created_at[gt|gte|lt|lte].
created_at[gte]stringnão
created_at[lte]stringnão
updated_atstringnãoIgualdade. Também updated_at[in]=a,b e updated_at[gt|gte|lt|lte].
updated_at[gte]stringnão
updated_at[lte]stringnão

Cabeçalhos

NomeTipoObrigatórioDescrição
x-origin-shared-secretstringnãoSegredo compartilhado entre o CloudFront e a origem. Obrigatório em produção; ignorado em desenvolvimento a menos que CF_ORIGIN_SHARED_SECRET esteja definido.

Respostas

HTTPDescrição
200Página de resultados.
400O corpo falhou na validação Zod. error.details carrega formErrors/fieldErrors.
404Recurso não encontrado ou filtrado por soft-delete.

agents create​

Criar agent

kobana inbox agents create [OPÇÕES]

POST /v1/agents

Cabeçalhos

NomeTipoObrigatórioDescrição
x-origin-shared-secretstringnãoSegredo compartilhado entre o CloudFront e a origem. Obrigatório em produção; ignorado em desenvolvimento a menos que CF_ORIGIN_SHARED_SECRET esteja definido.

Corpo da requisição

NomeTipoObrigatórioDescrição
labelstringsim
llm_modelstringsim
system_messagestringsim
external_idstringnãoOpcional. Usa por padrão o id interno gerado.
skills_repostring (uri)não
workflow_allowed_hostsarray<string>nãoHosts (exatos, ex.: api.example.com) para os quais um workflow devolvido por este agente pode enviar ${{secrets.*}}, ${{email.attachments.*}} ou a saída de um passo derivada deles. Vazio (o padrão) bloqueia todos os destinos para esses valores; passos sem eles não são afetados.
custom_metadataobjectnãoMetadados do usuário, formato livre. Envie null para limpar. Máx. 64 KB serializados, 16 níveis de profundidade.

Outros campos e objetos aninhados: kobana schema inbox.agents.create.

Respostas

HTTPDescrição
201Sucesso.
400O corpo falhou na validação Zod. error.details carrega formErrors/fieldErrors.
404Recurso não encontrado ou filtrado por soft-delete.
409Restrição de unicidade violada (ex.: external_id ou email da inbox já em uso).
422Validação do corpo que requer contexto do lado do servidor (ex.: domínio da inbox incompatível).

agents update​

Criar ou atualizar agente

kobana inbox agents update [OPÇÕES]

PUT /v1/agents

Upsert. Recebe o mesmo corpo do POST mais as chaves de busca id e external_id, casadas nessa ordem. Um match é atualizado in place e responde 200 — campos ausentes do corpo mantêm o valor armazenado. Sem chave, ou sem match, cria o agente exatamente como o POST faria e responde 201.

Cabeçalhos

NomeTipoObrigatórioDescrição
x-origin-shared-secretstringnãoSegredo compartilhado entre o CloudFront e a origem. Obrigatório em produção; ignorado em desenvolvimento a menos que CF_ORIGIN_SHARED_SECRET esteja definido.

Corpo da requisição

NomeTipoObrigatórioDescrição
labelstringsim
llm_modelstringsim
system_messagestringsim
external_idstringnãoCasa pelo id do sistema de origem. Também gravado no registro quando ele é criado.
skills_repostring (uri)não
workflow_allowed_hostsarray<string>nãoHosts (exatos, ex.: api.example.com) para os quais um workflow devolvido por este agente pode enviar ${{secrets.*}}, ${{email.attachments.*}} ou a saída de um passo derivada deles. Vazio (o padrão) bloqueia todos os destinos para esses valores; passos sem eles não são afetados.
custom_metadataobjectnãoMetadados do usuário, formato livre. Envie null para limpar. Máx. 64 KB serializados, 16 níveis de profundidade.
idstring (uuid)nãoCasa pelo id interno. Verificado antes de external_id.

Outros campos e objetos aninhados: kobana schema inbox.agents.update.

Respostas

HTTPDescrição
200Sucesso.
201Sucesso.
400O corpo falhou na validação Zod. error.details carrega formErrors/fieldErrors.
404Recurso não encontrado ou filtrado por soft-delete.
409Restrição de unicidade violada (ex.: external_id ou email da inbox já em uso).
422Validação do corpo que requer contexto do lado do servidor (ex.: domínio da inbox incompatível).

agents get​

Obter agent

kobana inbox agents get [ID] [OPÇÕES]

GET /v1/agents/{id}

Aceita tanto o UUID interno quanto o external_id do recurso.

Argumentos do caminho: id

Cabeçalhos

NomeTipoObrigatórioDescrição
x-origin-shared-secretstringnãoSegredo compartilhado entre o CloudFront e a origem. Obrigatório em produção; ignorado em desenvolvimento a menos que CF_ORIGIN_SHARED_SECRET esteja definido.

Respostas

HTTPDescrição
200Sucesso.
404Recurso não encontrado ou filtrado por soft-delete.

agents delete​

Excluir agent

kobana inbox agents delete [ID] [OPÇÕES]

DELETE /v1/agents/{id}

Aceita tanto o UUID interno quanto o external_id do recurso.

Argumentos do caminho: id

Cabeçalhos

NomeTipoObrigatórioDescrição
x-origin-shared-secretstringnãoSegredo compartilhado entre o CloudFront e a origem. Obrigatório em produção; ignorado em desenvolvimento a menos que CF_ORIGIN_SHARED_SECRET esteja definido.

Respostas

HTTPDescrição
200Excluído (soft delete).
404Recurso não encontrado ou filtrado por soft-delete.

agents versions​

Listar versões do prompt do agente

kobana inbox agents versions [ID] [OPÇÕES]

GET /v1/agents/{id}/versions

Paginação keyset. Filtros são query params tipados (campo=valor, campo[op]=valor); filtros desconhecidos, campos não ordenáveis e valores malformados são rejeitados com 400 VALIDATION_ERROR.

Argumentos do caminho: id

Parâmetros de consulta

NomeTipoObrigatórioDescrição
limitintegernão
cursorstringnãoCursor opaco retornado em meta.next_cursor da página anterior.
sort_bystringnãoCampo de ordenação. Permitidos: created_at, version. Sem ele, a ordem é version decrescente. Valores: created_at, version.
sort_orderstringnãoasc (padrão) ou desc. Exige sort_by. Valores: asc, desc.
versionintegernãoIgualdade. Também version[in]=a,b e version[gt|gte|lt|lte].
version[gte]integernão
version[lte]integernão
created_atstringnãoIgualdade. Também created_at[in]=a,b e created_at[gt|gte|lt|lte].
created_at[gte]stringnão
created_at[lte]stringnão

Cabeçalhos

NomeTipoObrigatórioDescrição
x-origin-shared-secretstringnãoSegredo compartilhado entre o CloudFront e a origem. Obrigatório em produção; ignorado em desenvolvimento a menos que CF_ORIGIN_SHARED_SECRET esteja definido.

Respostas

HTTPDescrição
200Página de resultados.
400O corpo falhou na validação Zod. error.details carrega formErrors/fieldErrors.
404Recurso não encontrado ou filtrado por soft-delete.