Sign in
step-assistants
Assistentes

Criar um assistente da etapa

Cria um assistente na etapa. Se active for verdadeiro, ele já entra em operação e passa a disparar no gatilho escolhido em execute_on: ao entrar na etapa (moved), ao sair dela (unlinked) ou somente sob demanda (manual).

É obrigatório indicar pelo menos um destino para o resultado: result_as_media grava como conteúdo do projeto e result_as_dynamic_form grava em um campo de formulário dinâmico. Os dois podem ser usados juntos.

A etapa do assistente é a do corpo (funnel_step_id) — é ela que vale, e não a da URL.

Cada execução consome créditos de IA. Veja Assistentes de etapa e Créditos de IA.

post/api/management/steps/{step}/assistants

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 nullable

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

Criado

responseboolean required

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

Changes

Changed in 3 of the 80 revisions of this API.21427

  • 3c590152d5b520424See the full diff
    • ▲

      request property was restricted to a list of enum values

      request-property-became-enum

    • ▲

      the request property became required

      request-property-became-required

    • ▲

      the request property became required

      request-property-became-required

    • ▲

      the request property became required

      request-property-became-required

    • ▲

      the request property became required

      request-property-became-required

    • ▲

      the request property became required

      request-property-became-required

    • ▲

      the request property / became required

      request-property-became-required

    • ▲

      the request property / became required

      request-property-became-required

    • ▲

      the request property / became required

      request-property-became-required

    • ▲

      the request property type changed from number to boolean

      request-property-type-changed

    • ▲

      the request property format changed from no format to uuid

      request-property-type-changed

    • ▲

      the request property type changed from string to integer

      request-property-type-changed

    • ▲

      the request property type changed from number to integer

      request-property-type-changed

    • ▲

      the request property type changed from number to boolean

      request-property-type-changed

    • ▲

      the / request property type changed from number to integer

      request-property-type-changed

    • ▲

      the / request property type changed from number to integer

      request-property-type-changed

    • ▲

      the request property type changed from number to boolean

      request-property-type-changed

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

      the request property became nullable

      request-property-became-nullable

    • ○

      the request property became nullable

      request-property-became-nullable

    • ○

      the request property / became nullable

      request-property-became-nullable

    • ○

      the request property / became nullable

      request-property-became-nullable

    • ○

      the request property / became nullable

      request-property-became-nullable

    • ○

      the request property / became nullable

      request-property-became-nullable

    • ○

      the request property / became nullable

      request-property-became-nullable

    • ○

      added the new manual enum value to the request property

      request-property-enum-value-added

    • ○

      added the new moved enum value to the request property

      request-property-enum-value-added

    • ○

      added the new unlinked enum value to the request property

      request-property-enum-value-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

  • d49d48cd1ce01See the full diff
    • ○

      api tag Assistentes added

      api-tag-added

  • 69f9300dc04512See the full diff
    • ▲

      removed the success response with the status

      response-success-status-removed

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the success response with the status

      response-success-status-added