Pular para o conteúdo principal

kobana kadu tasks

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

ComandoHTTPDescrição
tasks endpointGET /v1/tasks/{id}/endpointEndpoint HTTP de disparo da Task
tasks endpoint updatePUT /v1/tasks/{id}/endpointConfigura o endpoint HTTP da Task
tasks endpoint deleteDELETE /v1/tasks/{id}/endpointDesabilita o endpoint HTTP da Task
tasks listGET /v1/tasksLista tarefas
tasks createPOST /v1/tasksCria task
tasks getGET /v1/tasks/{id}Detalha a tarefa
tasks updatePATCH /v1/tasks/{id}Atualiza task
tasks deleteDELETE /v1/tasks/{id}Remove tasks (soft delete)
tasks readinessGET /v1/tasks/{id}/readinessPré-checagem do disparo
tasks runPOST /v1/tasks/{id}/runDispara execução

tasks endpoint​

Endpoint HTTP de disparo da Task

kobana kadu tasks endpoint [ID] [OPÇÕES] [COMANDO]

GET /v1/tasks/{id}/endpoint

Configuração do endpoint público POST /api/run-task/{task_id}. Credenciais nunca são devolvidas: só as flags *_set.

Argumentos do caminho: id

Respostas

HTTPDescrição
200OK
404NOT_FOUND
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

tasks endpoint update​

Configura o endpoint HTTP da Task

kobana kadu tasks endpoint update [ID] [OPÇÕES]

PUT /v1/tasks/{id}/endpoint

Cria ou atualiza. Credencial omitida mantém a gravada enquanto o tipo de auth não muda. Evite auth: params: o segredo vai na URL e fica nos logs de acesso de proxies e CDNs; prefira bearer ou header.

Argumentos do caminho: id

Corpo da requisição

NomeTipoObrigatórioDescrição
enabledbooleansim
authstringsimValores: basic, bearer, header, params.
auth_basic_userstringnão
auth_basic_passwordstringnão
auth_bearer_tokenstringnão
auth_header_keystringnão
auth_header_valuestringnão
auth_param_keystringnão
auth_param_valuestringnão

Outros campos e objetos aninhados: kobana schema kadu.tasks.endpoint.update.

Respostas

HTTPDescrição
200OK
404NOT_FOUND
409IDEMPOTENCY_KEY_REUSED / IDEMPOTENCY_REQUEST_IN_PROGRESS (ou CONFLICT da rota)
422INCOMPLETE_AUTH — falta credencial para o tipo de auth escolhido
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

tasks endpoint delete​

Desabilita o endpoint HTTP da Task

kobana kadu tasks endpoint delete [ID] [OPÇÕES]

DELETE /v1/tasks/{id}/endpoint

Mantém a configuração; um PUT com enabled: true reativa.

Argumentos do caminho: id

Respostas

HTTPDescrição
200OK
404NOT_FOUND
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

tasks list​

Lista tarefas

kobana kadu tasks list [OPÇÕES]

GET /v1/tasks

Parâmetros de consulta

NomeTipoObrigatórioDescrição
cursorstringnão
limitnumbernão
sort_bystringnãoCampo em snake_case: created_at (padrão), updated_at ou um campo filtrável.
sort_orderstringnãoPadrão: desc. Valores: asc, desc.

Respostas

HTTPDescrição
200OK
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

tasks create​

Cria task

kobana kadu tasks create [OPÇÕES]

POST /v1/tasks

A task nasce no tier de preço padrão; tier e modelo de IA são definidos pela Kobana (model no corpo é recusado).

Corpo da requisição

NomeTipoObrigatórioDescrição
labelstringsim
workspace_idstring (uuid)sim
activity_idstring (uuid)sim
skill_slugstringsim<plugin>:<skill> do repositório da organização: plugin do workspace (quando ele tem um), skill presente no catálogo sincronizado (quando há catálogo), nunca kadu:*.
parameters_schemaobjectnão
parameters_sensitivebooleannão
external_idstringnãoId do registro no sistema de origem (texto livre).
custom_metadataobjectnão

Outros campos e objetos aninhados: kobana schema kadu.tasks.create.

Respostas

HTTPDescrição
201created
400VALIDATION_ERROR
409IDEMPOTENCY_KEY_REUSED / IDEMPOTENCY_REQUEST_IN_PROGRESS (ou CONFLICT da rota)
422VALIDATION_ERROR — workspace/activity fora da organização ou skill_slug não permitido
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

tasks get​

Detalha a tarefa

kobana kadu tasks get [ID] [OPÇÕES]

GET /v1/tasks/{id}

Argumentos do caminho: id

Respostas

HTTPDescrição
200OK
404not found
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

tasks update​

Atualiza task

kobana kadu tasks update [ID] [OPÇÕES]

PATCH /v1/tasks/{id}

Argumentos do caminho: id

Corpo da requisição

NomeTipoObrigatórioDescrição
labelstringnão
skill_slugstringnão<plugin>:<skill> do repositório da organização: plugin do workspace (quando ele tem um), skill presente no catálogo sincronizado (quando há catálogo), nunca kadu:*.
parameters_schemaobjectnão
parameters_sensitivebooleannão
custom_metadataobjectnão

Outros campos e objetos aninhados: kobana schema kadu.tasks.update.

Respostas

HTTPDescrição
200OK
400VALIDATION_ERROR
404NOT_FOUND
409IDEMPOTENCY_KEY_REUSED / IDEMPOTENCY_REQUEST_IN_PROGRESS (ou CONFLICT da rota)
422VALIDATION_ERROR — skill_slug não permitido
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

tasks delete​

Remove tasks (soft delete)

kobana kadu tasks delete [ID] [OPÇÕES]

DELETE /v1/tasks/{id}

Exige o nível delete (ou all): write não apaga. Cascata: execuções e arquivos da task; cancela agendamentos e desliga o endpoint.

Argumentos do caminho: id

Respostas

HTTPDescrição
200OK
404NOT_FOUND
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

tasks readiness​

Pré-checagem do disparo

kobana kadu tasks readiness [ID] [OPÇÕES]

GET /v1/tasks/{id}/readiness

Se a Task pode rodar no ambiente: ambiente válido e valor para todas as secrets exigidas (no workspace da Task ou globais). Traz também a fila da Task. O disparo revalida tudo.

Argumentos do caminho: id

Parâmetros de consulta

NomeTipoObrigatórioDescrição
environment_idstringnão

Respostas

HTTPDescrição
200OK
404NOT_FOUND
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

tasks run​

Dispara execução

kobana kadu tasks run [ID] [OPÇÕES]

POST /v1/tasks/{id}/run

Argumentos do caminho: id

Corpo da requisição

NomeTipoObrigatórioDescrição
reference_datestringsim
environment_idstring (uuid)sim
parametersobjectnão
localestringnão
additional_instructionsstringnão
input_file_idsarray<string (uuid)>nãoArquivos enviados por POST /files (confirmados e ainda não usados).
modestringnãoresolve_pendencies só resolve as pendências das execuções anteriores da Task (console: "Resolver pendências"); parameters é ignorado. Valores: default, resolve_pendencies.

Outros campos e objetos aninhados: kobana schema kadu.tasks.run.

Respostas

HTTPDescrição
201created
409IDEMPOTENCY_KEY_REUSED / IDEMPOTENCY_REQUEST_IN_PROGRESS (ou CONFLICT da rota)
422COST_LIMIT_REACHED / INVALID_PARAMETERS / ENVIRONMENT_REQUIRED / MISSING_SECRETS (details.keys) / INVALID_INPUT_FILES
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).