---
title: "GetJobSummary"
method: POST
path: "/depot.ci.v1.CIService/GetJobSummary"
tags: ["CIService"]
---

# GetJobSummary

`POST /depot.ci.v1.CIService/GetJobSummary`

## Request

- Base URL: `https://api.depot.dev`
- URL: `https://api.depot.dev/depot.ci.v1.CIService/GetJobSummary`
- Auth: HTTP bearer

Returns authored step summary markdown for a job, a specific attempt, or both.

## Headers

- `Connect-Protocol-Version` 1, required: Define the version of the Connect protocol
- `Connect-Timeout-Ms` number: Define the timeout, in ms

## Request body

- DepotCiV1GetJobSummaryRequest
  - `jobId` string: Unique identifier for the job whose current attempt should be summarized. Required unless attemptId is set.
  - `attemptId` string: Unique identifier for a specific job attempt to summarize. Required unless jobId is set. When sent alongside jobId, the attempt must belong to that job.

## Response `200`

Success

- DepotCiV1GetJobSummaryResponse
  - `orgId` string: Organization that owns this job.
  - `runId` string: Unique identifier for the parent CI run.
  - `workflowId` string: Unique identifier for the parent workflow.
  - `jobId` string: Unique identifier for the job.
  - `attemptId` string: Unique identifier for the job attempt. Empty when no attempt exists yet.
  - `attempt` integer: Attempt number, starting at 1. Zero when no attempt exists yet.
  - `jobStatus` string: Current state of the job. Can be "queued", "waiting", "running", "finished", "failed", "cancelled", or "skipped". "waiting" means the job is blocked behind another run that holds the same `concurrency:` group slot.
  - `attemptStatus` string: Current state of the attempt. Can be "queued", "waiting", "running", "finished", "failed", or "cancelled". Empty when no attempt exists yet.
  - `hasSummary` boolean: True when authored step summary markdown is available for the selected attempt.
  - `emptyReason` string: Set when hasSummary is false, for example "no_summary" or "no_attempt".
  - `stepCount` integer: Count of non-empty step summaries included in markdown.
  - `markdown` string: Authored step summary markdown joined in step order.

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/depot/apis/depot-ci-api.md) - [All operations](https://skmtc.dev/depot/apis/depot-ci-api/llms.txt) - [OpenAPI document](https://skmtc.dev/depot/apis/depot-ci-api/revisions/6cf759b535b4?raw)