Getting Started

API Endpoints for Review

INTERNAL DOCUMENT: This document lists additional API endpoints that may be published as user-facing documentation. Review each section and decide which to include.

Currently Published (in /docs/public/api/)

Document Endpoints Status
index.md Overview Published
openai-compatible.md /v1/* endpoints Published
authentication.md API keys, OAuth Published
request-logs.md /api/account/request-logs/* Published
models.md /api/models/, /api/favorites/ Published
connections.md /api/connections/* Published
alerts.md /api/account/alerts/* Published
organizations.md /api/organizations/* Published
errors.md Error codes reference Published

Endpoints Pending Review

1. Billing & Credits API

Endpoints:

  • GET /api/billing/balance - Get credit balance
  • GET /api/billing/transactions - Transaction history
  • GET /api/billing/metrics - Billing metrics
  • POST /api/billing/checkout - Create Stripe checkout

Recommendation: Publish - users need to manage billing programmatically

Sample documentation needed:

  • Credit purchase flow
  • Transaction types
  • Webhook integration for payment events

2. User Prompts API

Endpoints:

  • GET /api/user/prompts - List user prompts
  • POST /api/user/prompts - Create prompt
  • PUT /api/user/prompts/{id} - Update prompt
  • DELETE /api/user/prompts/{id} - Delete prompt
  • POST /api/user/prompts/bulk - Bulk create

Recommendation: Publish - useful for prompt library management

3. Model Collections API

Endpoints:

  • GET /api/user/model-collections - List collections
  • POST /api/user/model-collections - Create collection
  • PUT /api/user/model-collections/{id} - Update
  • DELETE /api/user/model-collections/{id} - Delete
  • POST /api/user/model-collections/{id}/members - Add model

Recommendation: Publish - documented in models.md but could be expanded

4. Model Mappings API

Endpoints:

  • GET /api/user/model-mappings - List mappings
  • POST /api/user/model-mappings - Create mapping
  • POST /api/user/model-mappings/preview - Preview pattern
  • PUT /api/user/model-mappings/{id} - Update
  • DELETE /api/user/model-mappings/{id} - Delete

Recommendation: Review - advanced feature, may confuse new users

5. Model Ratings API

Endpoints:

  • GET /api/models/{modelId}/ratings - List ratings
  • POST /api/models/{modelId}/ratings - Add rating
  • DELETE /api/models/{modelId}/ratings - Remove rating
  • GET /api/ratings/my-ratings - User's ratings

Recommendation: Publish - useful for community features

6. User Quota API

Endpoints:

  • GET /api/user/quota/status - Current quota status
  • GET /api/user/quota/history - Quota usage history
  • POST /api/user/quota/request-increase - Request increase
  • POST /api/user/quota/estimate-cost - Estimate request cost

Recommendation: Publish - helps users manage rate limits

7. Support Tickets API

Endpoints:

  • GET /api/support/tickets - List tickets
  • POST /api/support/tickets - Create ticket
  • GET /api/support/tickets/{id} - Get ticket
  • PUT /api/support/tickets/{id} - Update ticket
  • POST /api/support/tickets/{id}/comments - Add comment

Recommendation: Review - may prefer to keep support in UI only

8. User Account API

Endpoints:

  • GET /api/account/handles - Get user handle
  • PUT /api/account/handles - Update handle

Recommendation: Publish - simple, useful for profile management

9. Automation Sessions API

Endpoints:

  • POST /api/automation/sessions - Create session
  • GET /api/automation/sessions - List sessions
  • GET /api/automation/sessions/{id} - Get session
  • PATCH /api/automation/sessions/{id} - Update session
  • DELETE /api/automation/sessions/{id} - Delete session
  • POST /api/automation/sessions/{id}/messages - Send message
  • GET /api/automation/sessions/{id}/conversation - Get conversation
  • POST /api/automation/sessions/{id}/complete - Complete session

Recommendation: Publish - core feature for automation users

10. Automation Templates API

Endpoints:

  • GET /api/automation/templates - List templates
  • POST /api/automation/templates - Create template
  • PUT /api/automation/templates/{id} - Update template
  • DELETE /api/automation/templates/{id} - Delete template

Recommendation: Publish alongside sessions

11. Public Endpoints (No Auth Required)

Endpoints:

  • GET /api/public/providers - List providers
  • GET /api/public/config - Platform config
  • GET /api/public/branding - White-label branding
  • GET /api/public/organizations - Public orgs
  • GET /api/public/organization/{slug} - Org info
  • GET /api/public/inference-servers - Available servers
  • GET /api/public/provider-profiles - Provider profiles

Recommendation: Publish - helps developers understand what's publicly available

Endpoints NOT to Publish (Admin/Internal)

These endpoints should remain internal:

Admin Endpoints (/api/admin/*)

  • Gateway management
  • Inference server management
  • Model templates
  • Quota templates
  • Audit logs
  • PII events
  • System status
  • Cron management
  • Member management (org-level)

Internal Endpoints

  • /api/automation/servers - Remote server management
  • /api/automation/ssh-keys - SSH key management
  • /api/automation/scripts - Script execution
  • /api/automation/gateways - Gateway instances
  • /api/automation/containers - Container management
  • /api/code/execute - Code execution

Decision Matrix

Endpoint Group Publish? Priority Notes
Billing/Credits Yes High Essential for programmatic billing
User Prompts Yes Medium Prompt library feature
Model Ratings Yes Low Community feature
User Quota Yes Medium Rate limit management
Automation Sessions Yes High Core automation feature
Automation Templates Yes High Goes with sessions
Public Endpoints Yes Medium Developer discovery
Support Tickets Review Low May prefer UI-only
Model Mappings Review Low Advanced, may confuse

Next Steps

  1. Review this document and mark which endpoints to publish
  2. Create documentation for approved endpoints
  3. Update index.md with new documentation links
  4. Consider SDK examples for high-priority endpoints

Notes for Documentation

When creating new endpoint documentation:

  1. Include > **Quick Access**: [Link](https://langmart.ai/page) header
  2. Add "Endpoints Overview" table
  3. Include request/response examples with curl
  4. Add Python/JavaScript examples for key operations
  5. Include "Platform Links" section
  6. Add "Related Documentation" section