Skip to content

Use the global endpoint URL across all docs#296

Merged
kylegani merged 1 commit into
masterfrom
global-endpoint-urls
Jul 15, 2026
Merged

Use the global endpoint URL across all docs#296
kylegani merged 1 commit into
masterfrom
global-endpoint-urls

Conversation

@kylegani

Copy link
Copy Markdown
Contributor

Summary

  • Replace regioned hostnames (api.aws.us-east-1.cerebrium.ai) with the global endpoint (api.cerebrium.ai) in every endpoint example — 32 files (endpoints, examples, partner services, migrations, TOML reference, introduction)
  • Add a note to the REST API page: regioned hostnames continue to work but are proxied to the global router, which can add latency; the global URL is the lowest-latency path
  • Normalize project-id placeholders in endpoint URLs to p-xxxxxxxx (previously 8+ inconsistent forms: p-xxxxx, <YOUR-PROJECT-ID>, {project-id}, [project-id], ...)
  • Fix ADA_L40SADA_L40 in the multi-region GPU availability table to match the accepted compute identifier

Deliberately untouched (later PR / different feature):

  • Internal app-to-app URLs (http://api.aws/v4/...) and custom-domain CNAME targets (proxy.aws.{region}...)
  • TOML region / provider config lines and region-selection prose
  • /v4/projects/{project_id}/volumes/... management API paths (different URL shape)

Verification

  • Repo-wide grep: no regioned public hostnames remain outside the intentional compatibility note
  • Prettier clean on all changed files
  • Note for reviewer: websocket examples now use wss://api.cerebrium.ai/... — worth a smoke test that websocket upgrades behave identically through the global router

🤖 Generated with Claude Code

Replace regioned hostnames (api.aws.us-east-1.cerebrium.ai) with the
global endpoint (api.cerebrium.ai) in all endpoint examples. Regioned
hostnames continue to work but are proxied to the global router, which
can add latency — a note in the REST API page now states this and
recommends the global URL.

Also:
- Normalize project-id placeholders in endpoint URLs to p-xxxxxxxx
  (previously 8+ inconsistent forms)
- Fix ADA_L40S -> ADA_L40 in the multi-region GPU availability table
  to match the accepted compute identifier

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
cerebrium 🟢 Ready View Preview Jul 15, 2026, 3:04 PM

@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
cerebrium 🟡 Building Jul 15, 2026, 3:02 PM

@kylegani
kylegani merged commit 923e476 into master Jul 15, 2026
2 checks passed
@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Docs PR opened: #297

Rewrote titles and descriptions on 30 endpoint, example, and integration pages to fix missing, too-short, and duplicate metadata.

Note: failed to automatically merge

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.

2 participants