Skip to main content
POST
/
v1
/
documents
curl -X POST https://api.doxmind.com/v1/documents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Q4 2024 Financial Report",
    "type": "report",
    "content": "Executive Summary\n\nThis report presents the financial performance...",
    "metadata": {
      "tags": ["finance", "quarterly", "2024"],
      "department": "Finance",
      "project": "Q4-REPORT-2024"
    },
    "aiSettings": {
      "autoEnhance": true,
      "suggestionLevel": "moderate",
      "language": "en"
    }
  }'
{
  "success": true,
  "data": {
    "id": "doc_kM9vY2hB8Qx3",
    "title": "Q4 2024 Financial Report",
    "type": "report",
    "content": "Executive Summary\n\nThis report presents the financial performance...",
    "status": "draft",
    "metadata": {
      "tags": ["finance", "quarterly", "2024"],
      "department": "Finance",
      "project": "Q4-REPORT-2024"
    },
    "aiSettings": {
      "autoEnhance": true,
      "suggestionLevel": "moderate",
      "language": "en"
    },
    "wordCount": 156,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z",
    "createdBy": {
      "id": "user_abc123",
      "name": "John Doe",
      "email": "[email protected]"
    }
  },
  "meta": {
    "requestId": "req_xY9pQ3rK",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

Request

title
string
required
The title of the document
type
string
default:"document"
The type of document. Options: document, report, article, research, technical
content
string
Initial content for the document
metadata
object
Additional metadata for the document
templateId
string
ID of a template to use for the document
aiSettings
object
AI configuration for the document

Response

success
boolean
Indicates if the request was successful
data
object
The created document object
curl -X POST https://api.doxmind.com/v1/documents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Q4 2024 Financial Report",
    "type": "report",
    "content": "Executive Summary\n\nThis report presents the financial performance...",
    "metadata": {
      "tags": ["finance", "quarterly", "2024"],
      "department": "Finance",
      "project": "Q4-REPORT-2024"
    },
    "aiSettings": {
      "autoEnhance": true,
      "suggestionLevel": "moderate",
      "language": "en"
    }
  }'
{
  "success": true,
  "data": {
    "id": "doc_kM9vY2hB8Qx3",
    "title": "Q4 2024 Financial Report",
    "type": "report",
    "content": "Executive Summary\n\nThis report presents the financial performance...",
    "status": "draft",
    "metadata": {
      "tags": ["finance", "quarterly", "2024"],
      "department": "Finance",
      "project": "Q4-REPORT-2024"
    },
    "aiSettings": {
      "autoEnhance": true,
      "suggestionLevel": "moderate",
      "language": "en"
    },
    "wordCount": 156,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z",
    "createdBy": {
      "id": "user_abc123",
      "name": "John Doe",
      "email": "[email protected]"
    }
  },
  "meta": {
    "requestId": "req_xY9pQ3rK",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}