step-assistants
Assistentes

Listar todos os assistentes de etapa

Changed on

Lista os assistentes de etapa de todos os funis da conta, sem precisar percorrer etapa por etapa. É a visão usada pelo menu de Assistentes de etapa.

Cada item já vem com a etapa e o agente de IA associados. Aceita filtros e paginação por query params, consulte:

Os campos de paginação (current_page, per_page, total, ...) vêm na raiz da resposta, ao lado de data, e não dentro de meta como no restante da API.

get/api/management/step-assistants

Request

  • Base URL: https://api.olie.ai
  • URL: https://api.olie.ai/api/management/step-assistants
  • Auth: HTTP bearer

Query parameters

pagestring

Página desejada. Padrão 1.

perPagestring

Itens por página. Padrão 30, máximo 100.

filter[id]string

ID (UUID) de um assistente específico. Aceita vários IDs separados por vírgula.

filter[name]string

Trecho do nome do assistente.

filter[active]string

1 retorna apenas os ativos, 0 apenas os inativos.

filter[funnel_step_id]string

ID da etapa do funil à qual o assistente pertence.

filter[ai_agent_id]string

ID (UUID) do agente de IA que executa o assistente.

Response

Sucesso

current_pageinteger required

Página retornada.

first_page_urlstring

Endereço da primeira página.

frominteger

Posição do primeiro item da página no total.

last_pageinteger

Número da última página.

last_page_urlstring

Endereço da última página.

next_page_urlstring

Endereço da próxima página, ou null na última.

pathstring

Endereço base usado para montar os links.

per_pageinteger required

Itens por página.

prev_page_urlstring

Endereço da página anterior, ou null na primeira.

tointeger

Posição do último item da página no total.

totalinteger required

Total de itens encontrados.

Changes

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property became nullable for the status

    • 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

    • breaking

      the response's property format changed from uri to no format for status

    • breaking

      the response's property format changed from uri to no format for status

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

      the response's property format changed from uri to no format for status

    • breaking

      the response's property type changed from no type to string 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

      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

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      api tag Assistentes added