report-ai
report_agents

Create Report Agent

Create a new Report Agent with auto-generated share_token.

post/api/v1/report-ai/report-agents

Request body

namestring required
system_promptstring required
source'voice_call' | 'text_session' | 'crm' | 'scheduled' | 'dashboard_insights' | 'email_thread' required

Source types for Report Agent triggers.

type'analysis' | 'action'

Whether this agent analyzes interactions or takes actions.

tenant_integration_idstring uuid nullable
voice_agent_idsstring[] nullable
min_call_duration_secondsinteger
modelstring
max_tool_callsinteger
triage_enabledboolean
triage_promptstring nullable
crm_closed_stage_idstring nullable
email_identity_idstring uuid nullable
timezonestring nullable
cron_expressionstring nullable
create_default_triggerboolean

Response

Successful Response

idstring uuid required
namestring required
system_promptstring required
source'voice_call' | 'text_session' | 'crm' | 'scheduled' | 'dashboard_insights' | 'email_thread' required

Source types for Report Agent triggers.

type'analysis' | 'action'

Whether this agent analyzes interactions or takes actions.

tenant_integration_idstring uuid nullable
voice_agent_idsstring[] nullable
min_call_duration_secondsinteger required
modelstring
max_tool_callsinteger
triage_enabledboolean
triage_promptstring nullable
crm_closed_stage_idstring nullable
email_identity_idstring uuid nullable
timezonestring nullable
tenant_idstring uuid required
enabledboolean required
is_dashboard_insightsboolean required
share_tokenstring required
property_codestring nullable
trigger_typesstring[]

Changes

Changed in 4 of the 28 revisions of this API.2111

    • ○

      added the new optional request property ////

      new-optional-request-property

    • ○

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

      response-optional-property-added

    • ○

      added the new optional request property //

      new-optional-request-property

    • ○

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

      response-optional-property-added

    • ▲

      removed from the // request property oneOf list

      request-property-one-of-removed

    • ▲

      added to the // response property oneOf list for the response status

      response-property-one-of-added

    • ○

      mapped value for discriminator key integration_tool_action changed from to for // request property

      request-property-discriminator-mapping-changed

    • ○

      added to the // request property oneOf list

      request-property-one-of-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

    • ○

      mapped value for discriminator key integration_tool_action changed from to for // response property for the response status

      response-property-discriminator-mapping-changed

    • ○

      removed from the // response property oneOf list for the response status

      response-property-one-of-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ●

      added the new email_thread enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new email_thread enum value to the request property

      request-property-enum-value-added

Of the 28 revisions, 1 has no diff computed.