v1

latestOpenAPI 3.0.02026-07-26193332.3 KB

REST API - Cost Estimations

Get cost estimation details

get/cost-estimations/{id}

Path parameters

idstring required

Response

idstring required

Estimation UUID

organization_idstring required

Organization UUID

user_idstring required

User UUID

namestring

Friendly name for this estimation

task_idstring required

Task identifier

status'pending' | 'running' | 'completed' | 'partial' | 'failed' required

Estimation status

total_creditsnumber

Total estimated credits across all repos

errorstring

Error message

triage_requiredboolean required

Whether human triage is mandatory for a scan of this estimation (large app, above the predicted-cost threshold). The customer cannot opt out when true.

triage_fee_creditsnumber required

Triage fee in credits (a percentage of the scan base credits) added when triage is enabled

created_atstring date-time required

Timestamp when estimation was created

updated_atstring date-time required

Timestamp when estimation was last updated

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization_id": "f336d0bc-b841-465b-8045-024475c079dd",
  "user_id": "f336d0bc-b841-465b-8045-024475c079dd",
  "task_id": "cost_est_owner-repo_12345",
  "status": "completed",
  "repos": [
    {
      "repo_url": "https://github.com/owner/repo",
      "branch": "main",
      "commit_sha": "abc123def456"
    }
  ],
  "total_credits": 8000,
  "repo_results": [
    {
      "repo_url": "https://github.com/owner/repo",
      "branch": "main",
      "commit_sha": "abc123def456",
      "status": "completed",
      "applications": [
        {
          "app_name": "backend-api",
          "app_root_path": "apps/api",
          "architecture": "NestJS REST API with PostgreSQL"
        }
      ],
      "credits": 4000
    }
  ],
  "triage_fee_credits": 1600,
  "created_at": "2026-03-10T12:00:00.000Z",
  "updated_at": "2026-03-10T12:05:00.000Z"
}