Skip to content

Add Embeddables REST API documentation#67

Merged
mrand-chameleon merged 4 commits intomainfrom
docs/add-embeddables-api
Feb 12, 2026
Merged

Add Embeddables REST API documentation#67
mrand-chameleon merged 4 commits intomainfrom
docs/add-embeddables-api

Conversation

@mrand-chameleon
Copy link
Contributor

@mrand-chameleon mrand-chameleon commented Feb 12, 2026

Summary

Adds documentation for the Embeddables REST API and updates repo documentation.

Changes

  • New apis/embeddables.mdx documenting:
    • List Embeddables (GET /v3/edit/embeds)
    • Retrieve an Embeddable (GET /v3/edit/embeds/:id)
    • Update an Embeddable (PATCH /v3/edit/embeds/:id)
  • Updated mint.json - Added embeddables to navigation (under REST API section)
  • Updated README.md - Reflects new Mintlify setup with local dev instructions
  • Fixed stale GitHub link in webhooks overview (pointed to old docs/ path)

Corrections from original draft

  • Fixed style values: should be banner or card (not auto/manual which are for Tours)
  • Fixed segment_id to segment_ids (array, not singular)
  • Fixed help center URL to correct location

Test plan

  • Verify embeddables page renders correctly at /apis/embeddables
  • Verify navigation link appears in REST API section
  • Verify internal links work (e.g., to Segments, Tags, URLs)
  • Verify README displays correctly on GitHub

🤖 Generated with Claude Code

mrand-chameleon and others added 3 commits February 12, 2026 12:56
- Add new embeddables.mdx documenting the Embeddables API endpoints
- List, Show, and Update operations for Embeddables
- Corrected style values: 'banner' and 'card' (not 'auto'/'manual')
- Corrected segment_ids to be array (not singular segment_id)
- Added to navigation in mint.json

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@mrand-chameleon mrand-chameleon merged commit 4a94e66 into main Feb 12, 2026
@mrand-chameleon mrand-chameleon deleted the docs/add-embeddables-api branch February 12, 2026 18:13
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.

3 participants