docs(docs): v0.96.x REST API migration guide#4164
Merged
Conversation
Expand the v0.96 changelog entry into a REST API migration guide, add a new REST API Guide section, and update all tutorial pages and notebooks that referenced the removed endpoints. Driven by customer feedback on removed endpoints (notably GET /apps and /preview/annotations). All curl examples verified against eu.cloud.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
dosubot
bot
added
size:XXL
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
jp-agenta
changed the title
jp-agenta
approved these changes
Apr 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Expand the v0.96.x changelog entry into a full REST API migration guide and bring every doc and notebook that referenced the removed endpoints up to date.
Why
A customer hit a 404 on
GET /api/appsand discovered a larger cliff: ~53 REST endpoints were removed in v0.96 and the auto-generated reference doesn't explain the new conventions. The existingunified-invoke-apichangelog only covered invocation, not the CRUD surface.What changed
New: REST API Guide (
docs/docs/reference/api-guide/)01-overview.mdx— entities (artifact/variant/revision), references, auth, response envelope.02-query-pattern.mdx—POST /{resource}/querybody shape, cursor-based windowing, archive/unarchive, cross-resource filtering gotcha.03-simple-endpoints.mdx— explains the/simple/prefix (collapses artifact+variant+revision into one call), with worked examples for/simple/applications/queryand/simple/traces/*, including the four common query shapes and a note about the twolinksfields.sidebars.tsunderReferencebetween Python SDK and API Reference.Renamed + expanded:
docs/blog/entries/unified-invoke-api.mdx## Other API Changessection: migration table for 19 removed endpoints, plus a "Notable caveats" subsection covering simple vs lean application query, project-scoped environments, annotation ID semantics, evaluator creation behavior, and the silentslugrequirement on commit.Updated tutorials and cookbook
docs/docs/tutorials/cookbooks/01-capture-user-feedback.mdxandexamples/jupyter/observability/capture_user_feedback.ipynb— migrated toPOST /api/simple/traces/.docs/docs/observability/trace-with-python-sdk/08-annotate-traces.mdxandexamples/jupyter/observability/annotate-traces-tutorial.ipynb— rewrote create/query/update/delete flows against/simple/traces/*. Renamedmetadatatometato match the current schema.docs/docs/prompt-engineering/managing-prompts-programatically/02-creating-prompts.mdx—/apps→/simple/applications/.docs/docs/prompt-engineering/managing-prompts-programatically/03-create-and-commit.mdx— mapped all/variants/configs/*flows to/applications/variants/*and/applications/revisions/*. Each REST example now shows the slug-to-UUID resolve step inline.docs/docs/prompt-engineering/managing-prompts-programatically/04-deploy.mdx—/variants/configs/deploy→/applications/revisions/deploywith slug-based refs.How it was verified
Every curl and JSON body in the new and updated docs was run against
eu.cloud.agenta.aiwith a test account API key. Four surprises caught during testing and fixed before commit:/simple/traces/queryhas twolinksfields. The top-level array matches on the trace's owntrace_id/span_id(batch lookup by id). The nestedtrace.links.invocationfilters on inbound links. The initial doc used the wrong one; now corrected, with a note explaining both.application_refs: [{"slug": "..."}]does not filter on/applications/variants/query. Works on/applications/query. Docs now show a two-step resolve.POST /applications/revisions/commitsilently returns{"count": 0}ifslugis missing. OpenAPI marks it optional. Docs now includeslugin every commit example.POST /simple/traces/does not auto-create the referenced evaluator. Behavior change from/preview/annotations/. Docs now explain that annotations accept any slug but the evaluator entity must be created explicitly to get aggregated stats in the UI.All four were flagged to @jpyamamoto separately for API-side decisions.
Test plan
pnpm --filter @agenta/docs build(or the docs build step in CI) succeeds.sidebars.tsrenders the new "REST API Guide" section under Reference.