Skip to content

Add compact video agent API responses - #23

Merged
devhims merged 2 commits into
mainfrom
feat/video-agent-response-schema
Sep 5, 2026
Merged

Add compact video agent API responses#23
devhims merged 2 commits into
mainfrom
feat/video-agent-response-schema

Conversation

@devhims

@devhims devhims commented Sep 5, 2026

Copy link
Copy Markdown
Owner

Changes

Agent run responses currently repeat identities and return detailed citations and artifacts alongside the answer. Add an opt-in responseFormat=compact to admission and polling so clients receive the answer, deduplicated numbered sources, warnings, outcome, and top-level billing.

  • Convert persisted citation markers to [1] references in first-use order, combining adjacent references to the same video. Reuse stored video titles where available.
  • Distinguish answered, partial, insufficient_evidence, and needs_clarification from execution status.
  • Expose excerpts, artifacts, and execution metadata only when requested with include=evidence,artifacts,diagnostics.
  • Keep the existing format as the default. Format selection applies per HTTP request and does not change execution, idempotency, stored evidence, or billing.
  • Update OpenAPI and Postman testing instructions.

This changes response serialization only. Internal transcript analysis and exact citation validation remain. Session restoration retains its existing format. Historical outcomes rely on persisted warnings; older runs without NO_CONTENT_EVIDENCE cannot always distinguish unavailable content from other partial results.

Validation

  • 355 unit tests across 51 files passed, including response transformation, outcomes, optional details, legacy compatibility, and request validation.
  • Platform TypeScript build, generated docs checks, Mintlify validation under Node LTS, and diff checks passed.
  • Local HTTP checks against previously completed GLM research and inspect runs verified source references, retained evidence, unchanged legacy results, and billing. No new model runs were needed for this serialization change.
  • The saved four-video research response is approximately 2.4 KB in compact form; detailed evidence remains available on request.

The broader web build could not complete locally because Turbopack encountered a port-binding permission error. CI should verify that build. No production deployment has been performed for this change.

@mintlify

mintlify Bot commented Sep 5, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
video2ctx 🟢 Ready View Preview Sep 5, 2026, 6:07 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@vercel

vercel Bot commented Sep 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
video2ctx-web Ready Ready Preview Sep 5, 2026 6:07pm UTC

@devhims
devhims merged commit 1a2461e into main Sep 5, 2026
7 checks passed
@devhims
devhims deleted the feat/video-agent-response-schema branch September 5, 2026 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant