---
title: "POST robots.job.summarize.completed"
method: POST
path: "robots.job.summarize.completed"
---

# POST robots.job.summarize.completed

`POST robots.job.summarize.completed` (webhook)

## Payload

- object
  - `type` 'robots.job.summarize.completed', required — Type for the webhook event
  - `id` string, required — Unique identifier for the event
  - `created_at` string, date-time, required — Time the event was created
  - `object` object, required
    - `type` string, required
    - `id` string, required
  - `environment` object, required
    - `name` string, required — Name for the environment
    - `id` string, required — Unique identifier for the environment
  - `attempts` object[], required — Attempts for sending out the webhook event
    - `webhook_id` integer — Unique identifier for the webhook
    - `response_status_code` integer — HTTP response status code for the webhook attempt
    - `response_headers` object — HTTP response headers for the webhook attempt
    - `response_body` string, nullable — HTTP response body for the webhook attempt
    - `max_attempts` integer — Max attempts number for the webhook attempt
    - `id` string — Unique identifier for the webhook attempt
    - `created_at` string, date-time — Time the webhook request was attempted
    - `address` string — URL address for the webhook attempt
  - `request_id` string, nullable
  - `accessor` string, nullable
  - `accessor_source` string, nullable
  - `data` object, required — The job that triggered the webhook event. In the actual payload this is nested under a dynamic event name key (e.g. `robots.job.summarize.completed`), not at the top level.
    - `id` string, required — Unique job identifier.
    - `passthrough` string — Arbitrary string supplied at creation, returned as-is.
    - `units_consumed` integer, required — Number of Mux AI units consumed by this job.
    - `created_at` integer, required — Unix timestamp (seconds) when the job was created.
    - `updated_at` integer, required — Unix timestamp (seconds) when the job was last updated.
    - `workflow` 'summarize', required
    - `parameters` object, required
      - `asset_id` string, required — The Mux asset ID of the video to summarize.
      - `tone` 'neutral' | 'playful' | 'professional' — Tone for the generated summary. "neutral" for straightforward analysis, "playful" for witty and conversational, "professional" for executive-level reporting.
      - `prompt_overrides` object — Override specific sections of the summarization prompt.
        - `task` string — Override the core task instruction for summarization.
        - `title` string — Override the title generation requirements.
        - `description` string — Override the description generation requirements.
        - `keywords` string — Override the keyword/tag extraction requirements.
        - `quality_guidelines` string — Override the quality standards for analysis.
      - `title_length` integer — Maximum title length in words.
      - `description_length` integer — Maximum description length in words.
      - `tag_count` integer — Maximum number of tags to include in the generated output. Defaults to 10.
      - `language_code` string — BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When omitted, the SDK uses the default track.
      - `output_language_code` string — BCP 47 language code for the generated summary output (e.g. "en", "fr", "ja"). Auto-detected from the transcript if omitted.
    - `status` 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled', required — Current job status.
    - `outputs` object — Workflow results. Present when status is 'completed'.
      - `title` string, required — Generated title capturing the essence of the video.
      - `description` string, required — Generated description of the video content (typically 2-4 sentences).
      - `tags` string[], required — Generated keyword tags for the video.
    - `errors` object[] — Error details. Present when status is 'errored'.
      - `type` string, required — Stable public error category identifier.
      - `message` string, required — Human-readable public error message.
      - `retryable` boolean — Whether retrying this job may resolve the error.
    - `resources` object — Related Mux resources linked to this job.
      - `assets` object[], required — Mux assets associated with this job.
        - `id` string, required — Mux asset ID.
        - `meta` object — Mux asset metadata, if available.
          - `title` string — Asset title from Mux metadata.
          - `creator_id` string — Creator identifier from Mux metadata.
          - `external_id` string — External identifier from Mux metadata.
        - `passthrough` string — Passthrough string from the Mux asset.
        - `_links` object, required — Hypermedia links for the asset.
          - `self` object, required
            - `href` string, required — URL to the Mux asset resource.

## Acknowledgement `200`

Return a 200 to indicate that the data was received successfully

---

[API](https://skmtc.net/muxinc/apis/mux-api.md) · [All operations](https://skmtc.net/muxinc/apis/mux-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/muxinc/mux-api/revisions/34a65dce0f31/schema)