Generate an AI Wave Summary using an API

You can now generate and retrieve “AI Wave Summary” for eligible wave runs using new REST endpoints.

Generating and retrieving AI Wave Summaries via API provides faster exception handling and easier integration with dashboards or workflows, without relying on the Wave Inquiry UI. You’ll have reduced time to diagnose wave failures or confirm completion outcomes.

ENDPOINT

POST wms/lgfapi/v10/entity/wave/ai_wave_summary

SAMPLE PAYLOAD

{

  "parameters": {

    "facility_id__code": "QATST01",

    "wave_nbr": "WV123001",

    "lang_code": "en_US"

  }

}

NOTE: if an AI Wave Summary was already generated via the UI for that wave number, the API will not generate a new one. If not already generated, the system will generate it. Cancelled waves are not supported.

LANGUAGE SUPPORT

LLM-supported languages: English, German, French, Italian, Portuguese, Spanish

If the requested language is not supported, the summary is returned in English.

RETRIEVE AI WAVE SUMMARY (GET)

Fetch Paginated List

Returns paginated AI Wave Summary records for wave runs.

GET wms/lgfapi/v10/entity/ai_wave_summary

Fetch Specific Summary by ID (Non-Paginated) 

Returns the AI Wave Summary for the specified record ID.

GET wms/lgfapi/v10/entity/ai_wave_summary/{id}

Steps to enable and configure

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.