TBPI Analysis

Analyze Pillar

Initiate TBPI analysis for a specific pillar

This endpoint starts an asynchronous analysis process. The analysis runs in the background and can take 60-90 seconds to complete.

Process:

  1. Validates RSSD ID and pillar
  2. Creates analysis session
  3. Launches background analysis task
  4. Returns session ID for progress tracking

Usage:

POST /api/v1/tbpi/analyze
{
    "rssd_id": "59754",
    "pillar": "revenue"
}

Poll /progress/{session_id} to track progress.

post/api/v1/tbpi/analyze

Request

  • Base URL: https://app.perlucem.ai (the document declares no server; this is the origin it was published from)
  • URL: https://app.perlucem.ai/api/v1/tbpi/analyze
  • Auth: HTTP bearer

Request body

rssd_idstring required

Bank RSSD ID

pillarstring required

Pillar to analyze

start_periodstring nullable

Start period (e.g., '12/31/2024')

end_periodstring nullable

End period (e.g., '9/30/2025')

Example request

{
  "end_period": "9/30/2025",
  "pillar": "revenue",
  "rssd_id": "59754",
  "start_period": "12/31/2024"
}

Response

Successful Response

session_idstring required
rssd_idstring required
pillarstring required
statusstring required
messagestring required

Example response

{
  "message": "Analysis initiated successfully. Poll /progress/{session_id} for updates.",
  "pillar": "revenue",
  "rssd_id": "59754",
  "session_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "in_progress"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.