Application

Upsert application summary

Changed on

Create a new application summary version (AI-generated or user-created). Version number is auto-incremented.

post/applicationSummary

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/applicationSummary
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Headers

If-Matchstring

ETag of the current latest summary. Required when creating subsequent versions to prevent race conditions. Omit only when creating the first summary for an application. Returns 412 if:

  • Provided but no summary exists for the application
  • Provided but doesn't match the current latest version's ETag
  • Omitted when a summary already exists for the application

Request body

idstring

Unique identifier for the application summary

versioninteger

Business version number of this summary (auto-incremented by server)

workspace_idstring required

ID of workspace associated with this summary

application_idstring required

ID of the application this summary describes

created_timeinteger

Time summary was created (epoch milliseconds)

created_by_idstring

ID of user or client who created the summary

summarystring required

The full AI-generated summary text

headlinestring

Short headline version of the summary

previous_agent_summary_idstring

ID of the previous AI-generated summary this was based on

is_user_created_versionboolean required

Whether this version was created or edited by a user

user_edits_summarystring

User-provided summary text if is_user_created_version is true

agent_type'test_authoring' | 'flow_authoring' | 'test_creation_planning' | 'test_planning' | 'agent_review' | 'app_summary' | 'test_run_analysis' | 'test_recovery' | 'runtime_recovery_summary_agent' | 'plan_run_analysis' | 'deployment_analysis' | 'workspace_results_analysis' | 'results_auto_analysis' | 'workspace_assistant' | 'app_modeling' | 'app_modeling_run' | 'file_assertion' | 'test_impact' | 'test_impact_shadow' | 'repair_notes'
agent_versionstring

Version of the AI agent that generated this summary

test_summaries_used_countinteger

Number of test summaries used to generate this summary

test_details_used_invariant_idsstring[]

Invariant IDs of tests whose details were used

screenshots_used_countinteger

Number of screenshots analyzed for this summary

Response

Application summary created

idstring

Unique identifier for the application summary

versioninteger

Business version number of this summary (auto-incremented by server)

workspace_idstring required

ID of workspace associated with this summary

application_idstring required

ID of the application this summary describes

created_timeinteger

Time summary was created (epoch milliseconds)

created_by_idstring

ID of user or client who created the summary

summarystring required

The full AI-generated summary text

headlinestring

Short headline version of the summary

previous_agent_summary_idstring

ID of the previous AI-generated summary this was based on

is_user_created_versionboolean required

Whether this version was created or edited by a user

user_edits_summarystring

User-provided summary text if is_user_created_version is true

agent_type'test_authoring' | 'flow_authoring' | 'test_creation_planning' | 'test_planning' | 'agent_review' | 'app_summary' | 'test_run_analysis' | 'test_recovery' | 'runtime_recovery_summary_agent' | 'plan_run_analysis' | 'deployment_analysis' | 'workspace_results_analysis' | 'results_auto_analysis' | 'workspace_assistant' | 'app_modeling' | 'app_modeling_run' | 'file_assertion' | 'test_impact' | 'test_impact_shadow' | 'repair_notes'
agent_versionstring

Version of the AI agent that generated this summary

test_summaries_used_countinteger

Number of test summaries used to generate this summary

test_details_used_invariant_idsstring[]

Invariant IDs of tests whose details were used

screenshots_used_countinteger

Number of screenshots analyzed for this summary

Changes

  • 0ddfcf08c4a8Revision changes
    • warning

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

    • info

      added the new flow_authoring enum value to the request property

  • ae1104aba49eRevision changes
    • warning

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

    • info

      added the new test_impact_shadow enum value to the request property