Skip to content

docs(api): document canonical v1 routes - #714

Open
DarrenBaldwin07 wants to merge 1 commit into
mainfrom
tembo/docs-public-api-v1
Open

docs(api): document canonical v1 routes#714
DarrenBaldwin07 wants to merge 1 commit into
mainfrom
tembo/docs-public-api-v1

Conversation

@DarrenBaldwin07

Copy link
Copy Markdown
Contributor

Summary

  • advertise https://api.tembo.io/v1/ as the canonical hosted API base
  • advertise /api/public-api/v1/ as the canonical self-hosted API base
  • update curl, SDK, OpenAPI, and Snowflake examples to use the versioned routes
  • correct the self-hosted follow-up-message sample so it uses the self-hosted host

Validation

  • parsed both OpenAPI YAML files successfully
  • confirmed hosted and self-hosted specs expose matching operation paths
  • scanned the API docs for stale versionless public endpoint URLs
  • ran git diff --check

Rollout

This documentation should merge after the API /v1 routing change is deployed. Hosted versionless URLs remain backward-compatible, but /v1 is the canonical documented contract.


Want tembo to make any changes? Add a comment with @tembo and i'll get back to work!

View on Tembo  Review in Tembo  View Agent Settings

Co-authored-by: Darren <68653294+DarrenBaldwin07@users.noreply.github.com>
@tembo tembo Bot added the tembo Pull request created by Tembo label Aug 22, 2026
@mintlify

mintlify Bot commented Aug 22, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
tembo 🟢 Ready View Preview Aug 22, 2026, 3:54 PM

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

@tembo

tembo Bot commented Aug 30, 2026

Copy link
Copy Markdown
Contributor

Recommendation: close this PR without merging.

The proposed /v1 prefix is not implemented for the legacy session, repository, agent, or MCP routes in published releases v0.2.826 through v0.2.828, and current main still mounts those routes without /v1. No published or draft release contains the routing change described here.

The ongoing resource API rollout does use /public-api/v1, but with different plural routes and contracts (for example, /public-api/v1/agents and /public-api/v1/repositories). Therefore paths such as /v1/session/list, /v1/agent, and /v1/mcp will not become correct merely when that rollout finishes.

The self-hosted hostname correction is valid and can be preserved in a separate focused change, but the versioned route replacements and the OpenAPI/Snowflake examples should not ship as written.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tembo Pull request created by Tembo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant