Feedback: api-reference-lemur-purge-request-data

Documentation Feedback

Original URL: https://www.assemblyai.com/docs/api-reference/lemur/purge-request-data
Category: api-reference
Generated: 05/08/2025, 4:32:11 pm

---

Claude Sonnet 4 Feedback

Generated: 05/08/2025, 4:32:10 pm

Technical Documentation Analysis & Recommendations

Critical Issues Requiring Immediate Attention

1. Redundant Examples (High Priority)

Problem: Eight identical cURL examples create visual clutter and confusion. Solution: Replace with diverse, meaningful examples:

# Basic deletion
curl -X DELETE https://api.assemblyai.com/lemur/v3/12345 \
     -H "Authorization: Bearer your_api_key_here"

# EU server example
curl -X DELETE https://api.eu.assemblyai.com/lemur/v3/12345 \
     -H "Authorization: Bearer your_api_key_here"

2. Missing Response Details (High Priority)

Problem: Only HTTP status codes listed; no response body structure or examples. Solution: Add complete response documentation:

// 200 Success Response
{
  "request_id": "12345",
  "deleted": true,
  "message": "LeMUR request data successfully deleted"
}

// 404 Error Response
{
  "error": "Request not found",
  "request_id": "12345"
}

3. Inconsistent Parameter Format (Medium Priority)

Problem: Examples mix request_id and :request_id formats. Solution: Standardize on realistic examples with actual IDs.

Structural Improvements

Current Structure Issues:

• Poor information hierarchy
• Missing contextual information
• No success/error handling guidance

Recommended Structure:

# Purge LeMUR Request Data

## Overview
Brief description of the endpoint's purpose and when to use it.

## Endpoint Details
[HTTP method and URL with clear parameter notation]

## Authentication & Headers
[Required headers with examples]

## Parameters
[Detailed parameter descriptions]

## Request Examples
[Multiple relevant examples]

## Response Format
[Complete response schemas with examples]

## Error Handling
[Common errors and troubleshooting]

## Use Cases & Best Practices
[When and how to use this endpoint effectively]

Missing Information

Authentication Details

• No explanation of API key format (Bearer token vs API key)
• Missing header requirements beyond Authorization
• No mention of API key location/generation

Data Retention Context

• No information about data retention policies
• Missing details about what specific data gets deleted
• No explanation of deletion permanence

Rate Limiting Details

• 429 error mentioned but no rate limit specifics
• No guidance on retry strategies

Enhanced Documentation Template

# Purge LeMUR Request Data

Permanently delete all data associated with a specific LeMUR request, including the LLM response and original context data.

⚠️ **Warning:** This action is irreversible. Once deleted, the request data cannot be recovered.

## Endpoint
```http
DELETE https://api.assemblyai.com/lemur/v3/{request_id}

Authentication

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Parameters

Parameter	Type	Required	Description
request_id	string	Yes	The unique identifier of the LeMUR request to delete. Found in the original request response.

Request Examples

Basic Request

curl -X DELETE "https://api.assemblyai.com/lemur/v3/lemur_12345abcd" \
     -H "Authorization: Bearer your_api_key_here"

EU Server

curl -X DELETE "https://api.eu.assemblyai.com/lemur/v3/lemur_12345abcd" \
     -H "Authorization: Bearer your_api_key_here"

Response Format

Success (200)

{
  "request_id": "lemur_12345abcd",
  "deleted": true,
  "deleted_at": "2024-01-15T10:30:00Z"
}

Error Responses

[Detailed error examples with explanations]

Common Use Cases

• Compliance with data retention policies
• Cleaning up test/development requests
• Managing storage costs

Best Practices

• Verify request_id before deletion
• Keep logs of deleted requests for audit purposes
• Consider data retention requirements before deletion

## User Experience Pain Points

1. **Lack of Context:** Users don't understand when/why to use this endpoint
2. **No Error Recovery:** No guidance on handling failures
3. **Missing Validation:** No explanation of valid request_id formats
4. **Poor Discoverability:** No links to related endpoints or workflows

## Priority Action Items

1. **Immediate:** Remove duplicate examples, add response body details
2. **Short-term:** Add authentication details, error handling guidance
3. **Medium-term:** Improve structure, add use cases and best practices
4. **Long-term:** Create cross-references to related LeMUR endpoints

This documentation needs significant improvement to meet professional API documentation standards and provide a good developer experience.

---