step-assistants
Assistentes

Atualizar um assistente da etapa

Changed on

Substitui a configuração do assistente. O corpo é o mesmo da criação e não aceita atualização parcial: name, funnel_step_id, ai_agent_id, prompt e execute_on precisam vir a cada requisição, e ao menos um destino de resultado continua obrigatório.

Enviar active: false tira o assistente de operação sem apagar nada: a configuração e o histórico de execuções permanecem, mas ele deixa de disparar.

put/api/management/steps/{step}/assistants/{assistant}

Request

  • Base URL: https://api.olie.ai
  • URL: https://api.olie.ai/api/management/steps/{step}/assistants/{assistant}
  • Auth: HTTP bearer

Request body

namestring required

Nome do assistente. Obrigatório, até 255 caracteres.

activeboolean

Define se o assistente entra em operação. Padrão true.

funnel_step_idinteger required

ID da etapa do funil à qual o assistente pertence. Obrigatório — é este campo que vale, e não o ID da URL.

ai_agent_idstring uuid required

ID (UUID) do agente de IA que executa a tarefa. Obrigatório e precisa pertencer à mesma conta.

promptstring required

Instrução dada ao agente. Obrigatória. Aceita a sintaxe avançada, com dados do projeto e da etapa.

execute_on'moved' | 'unlinked' | 'manual' required

Gatilho do assistente: moved ao entrar na etapa, unlinked ao sair dela e manual só sob demanda.

manual_execution_enabledboolean

Permite disparar o assistente sob demanda mesmo com gatilho automático. Padrão false.

failure_funnel_step_idinteger

Etapa para onde o projeto vai se a execução falhar. Precisa ser da mesma conta e diferente de funnel_step_id. null deixa o projeto onde está.

result_as_mediaboolean

Grava o resultado como conteúdo do projeto. Obrigatório quando result_as_dynamic_form não é enviado.

Response

Sucesso

responseboolean required

Sempre true quando a operação é concluída.

Changes

  • 4a8f726dba52Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

  • 3c590152d5b5Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • breaking

      the request property type changed from number to boolean

    • breaking

      the request property format changed from no format to uuid

    • breaking

      the request property type changed from string to integer

    • breaking

      the request property type changed from number to integer

    • breaking

      the request property type changed from number to boolean

    • breaking

      the / request property type changed from number to integer

    • breaking

      the / request property type changed from number to integer

    • breaking

      the request property type changed from number to boolean

    • breaking

      the response property / became nullable for the status

    • breaking

      the / response's property type changed from no type to string, and format from no format to date-time for status

    • breaking

      the / response's property type changed from no type to object for status

    • warning

      added the new manual enum value to the / response property for the response status

    • warning

      added the new moved enum value to the / response property for the response status

    • warning

      added the new unlinked enum value to the / response property for the response status

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      added the new manual enum value to the request property

    • info

      added the new moved enum value to the request property

    • info

      added the new unlinked enum value to the request property

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status