Skip to content

docs(api): use public API endpoint prefix #680

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vrmiguel wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(api): use public API endpoint prefix #680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Generate an API key from **Settings > API Keys** in the [dashboard](https://app.

```bash
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.tembo.io/session/list
https://api.tembo.io/public-api/session/list
```

## SDK
Expand Down
6 changes: 3 additions & 3 deletions integrations/snowflake.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The integration is implemented as a Snowflake-managed MCP server that exposes Te
- `CREATE AGENT` on the target schema
- `USAGE` on a warehouse the agent will run with
- A Tembo API token — generate one from your Tembo account settings
- The Tembo REST API base URL: `https://api.tembo.io`
- The Tembo REST API base URL: `https://api.tembo.io/public-api`

For self-hosted Tembo installs, substitute your deployment's base URL throughout. See [Self-Hosted Overview](/features/self-hosted/overview) for details.

Expand Down Expand Up @@ -96,7 +96,7 @@ PACKAGES = ('requests')
AS $$
import _snowflake, json, requests

BASE = "https://api.tembo.io"
BASE = "https://api.tembo.io/public-api"

ROUTES = {
"list_sessions": ("GET", "/session/list"),
Expand Down Expand Up @@ -333,7 +333,7 @@ SHOW EXTERNAL ACCESS INTEGRATIONS LIKE 'tembo_api_access_integration';
</Accordion>

<Accordion title="Self-hosted Tembo">
For self-hosted Tembo, replace `https://api.tembo.io` with your deployment's base URL in both the network rule (`VALUE_LIST`) and the Python UDF (`BASE`). The rest of the flow is identical.
For self-hosted Tembo, replace `https://api.tembo.io/public-api` with your deployment's public API base URL (for example, `https://tembo.example.com/api/public-api`) in the Python UDF (`BASE`). Update the network rule (`VALUE_LIST`) to allow your deployment's host. The rest of the flow is identical.
</Accordion>

<Accordion title="Rotating the API token">
Expand Down
10 changes: 5 additions & 5 deletions openapi.documented.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
description: Tembo Developer API
version: 1.0.0
servers:
- url: https://api.tembo.io/
- url: https://api.tembo.io/public-api/
description: Tembo API
components:
securitySchemes:
Expand Down Expand Up @@ -552,7 +552,7 @@ paths:
label: cURL
source: |-
curl -s -X POST \
"https://api.tembo.io/session/${SESSION_ID}/messages" \
"https://api.tembo.io/public-api/session/${SESSION_ID}/messages" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Content-Type: application/json" \
-d '{"content": "Please add a regression test for this change."}'
Expand Down Expand Up @@ -702,7 +702,7 @@ paths:
- lang: bash
source: |-
curl -s -X POST \
"https://api.tembo.io/agent" \
"https://api.tembo.io/public-api/agent" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Content-Type: application/json" \
-d '{
Expand Down Expand Up @@ -812,15 +812,15 @@ paths:
label: Bearer Auth
source: |-
curl -s -X POST \
"https://api.tembo.io/agent/${AGENT_ID}/trigger" \
"https://api.tembo.io/public-api/agent/${AGENT_ID}/trigger" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Content-Type: application/json" \
-d '{"issue_url": "https://github.com/org/repo/issues/42"}' | jq .
- lang: bash
label: Query Param Auth
source: |-
curl -s -X POST \
"https://api.tembo.io/agent/${AGENT_ID}/trigger?apiKey=${API_KEY}" \
"https://api.tembo.io/public-api/agent/${AGENT_ID}/trigger?apiKey=${API_KEY}" \
-H "Content-Type: application/json" \
-d '{"issue_url": "https://github.com/org/repo/issues/42"}' | jq .
/repository/list:
Expand Down
2 changes: 1 addition & 1 deletion openapi.self-hosted.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -552,7 +552,7 @@ paths:
label: cURL
source: |-
curl -s -X POST \
"https://api.tembo.io/session/${SESSION_ID}/messages" \
"https://tembo.example.com/api/public-api/session/${SESSION_ID}/messages" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Content-Type: application/json" \
-d '{"content": "Please add a regression test for this change."}'
Expand Down