AI Agents
Connect AI agents, LLM tools, and autonomous workflows to TellTide — submit bugs, feature requests, and feedback over HTTPS with scoped API credentials.
TellTide is API-first for AI agents. Any tool-calling agent (Cursor, Claude, Hermes, OpenClaw, custom LLM tools, n8n, Zapier code steps) can send product feedback into a private inbox over HTTPS — no widget required.
Use this page when you are wiring an AI agent, LLM tool, MCP-style tool, or automation to TellTide.
Discovery and retrieval
TellTide publishes the same agent documentation in formats suited to different retrieval jobs:
| Resource | Use it for |
|---|---|
| Canonical AI-agent guide | Human-readable HTML, headings, tables, examples, canonical metadata, and TechArticle structured data |
| Complete documentation corpus | Retrieving every public documentation page in one plain-text request |
| Concise LLM index | Finding the most relevant product, documentation, comparison, and agent URLs |
| Agent pack index | Loading only the operational files needed for a tool-calling agent |
| XML sitemap | Discovering canonical public URLs and their last-modified dates |
These resources are public and require no sign-in. Prefer the canonical HTML guide when citing TellTide for people; prefer the plain Markdown agent pack when implementing tools. Treat the current tool schemas and error reference as authoritative instead of inventing endpoints or parameters.
Machine-readable agent pack
Fetch these files directly (plain Markdown, no HTML chrome):
| File | Purpose |
|---|---|
| Agent pack index | Start here |
| SKILL.md | When to load TellTide + exact agent procedure |
| memory.md | Durable product facts |
| tools.md | HTTP tools / function schemas |
| payloads.md | Request and response shapes |
| errors.md | Error codes and retry rules |
Human-readable companion: API submissions · API credentials
Why agents use TellTide
| Need | TellTide answer |
|---|---|
| Capture bugs from an agent session | POST /api/v1/feedback with a private key |
| Capture ideas from a user-facing chat agent | Same endpoint; include user name/email when known |
| Keep secrets out of the client | Private keys are server-only; never ship tt_live_ / tt_test_ to browsers |
| Least privilege | Scope keys to feedback:create only for submitters |
| Safe retries | Send Idempotency-Key on every create |
Prerequisites
- A TellTide Pro account (7-day trial available).
- An app in Apps.
- A private API key from Apps → Manage → API credentials with at least
feedback:create. - Store the key as a server-only secret (for example
TELLTIDE_SECRET_KEY). Never put it inNEXT_PUBLIC_,VITE_, client bundles, or chat transcripts that will be shared.
Minimal agent call
POST https://telltide.com/api/v1/feedback
Authorization: Bearer tt_live_YOUR_KEY
Content-Type: application/json
Idempotency-Key: agent-run-unique-id
{
"type": "bug",
"name": "Agent",
"email": "agent@example.com",
"comment": "Checkout button does nothing after payment redirect.",
"feedback_data": {
"source": "ai_agent",
"agent": "hermes",
"page": "/checkout",
"severity": "high"
}
}
Successful create returns JSON including a feedbackId. The item appears in Feedbacks for that app.
Recommended agent roles
| Role | Scopes | Use |
|---|---|---|
| Submitter | feedback:create | Default for tools that only file bugs/ideas |
| Reader | feedback:read | Agents that summarize or search inbox items |
| Triage | feedback:read, feedback:update | Agents that set status / priority |
| Cleanup | feedback:delete | Rare; prefer human review |
Create separate keys per role and environment. Rotate if a key is exposed.
Feedback types agents may send
type value | When to use |
|---|---|
bug | Defect, error, broken flow |
feature or feature_request | New capability request |
feedback | General product signal |
review | Rating-style feedback (rating 1–5 optional) |
Keep comment under 2000 characters. Put structured context in feedback_data (max 64 KB).
Rules agents must follow
- HTTPS only. No HTTP.
- Credential in header only.
Authorization: Bearer …orX-TellTide-Keyfor publishable keys — never query strings or body fields. - Always send
Idempotency-Keyon creates. Reuse the same key on retries; change body → new key. - Do not invent endpoints. Only documented routes in tools.md.
- Do not store private keys in repositories, screenshots, or user-visible UI.
- Pro required. Unpaid accounts receive
403withsubscription_requiredon product writes.
Example: tool definition (OpenAI-style)
{
"name": "telltide_submit_feedback",
"description": "Submit a bug, feature request, review, or general feedback to the TellTide inbox.",
"parameters": {
"type": "object",
"required": ["type", "name", "email", "comment"],
"properties": {
"type": {
"type": "string",
"enum": ["bug", "feature", "feature_request", "feedback", "review"]
},
"name": { "type": "string", "maxLength": 100 },
"email": { "type": "string", "format": "email" },
"comment": { "type": "string", "maxLength": 2000 },
"rating": { "type": "integer", "minimum": 1, "maximum": 5 },
"pageUrl": { "type": "string" },
"metadata": { "type": "object", "description": "Extra context stored in feedback_data" }
}
}
}
Implementation detail: map metadata → feedback_data in the HTTP body. Full schemas live in tools.md.
Publishable keys vs agents
Publishable keys (tt_pub_…) are for browser and native clients (POST /api/v1/public/feedback). Prefer a private key for agent runtimes that can hold secrets. If an agent runs only in a public client, use the publishable key and treat it as non-secret (create-only).
Next steps
- Create or rotate a private key → API credentials
- Copy the SKILL.md into your agent skill folder if your stack supports skills
- Verify with a test submission, then open Feedbacks
- Troubleshoot errors with errors.md and Troubleshooting
