Analysis API

Analysis API v1 Advanced document analysis and AI-powered insights system.

This API provides comprehensive analysis capabilities for documents, including content analysis, quality assessment, and automated insights generation.

Analysis capabilities:

• Document content analysis and quality metrics

• Automated insight generation and recommendations

• Document structure and formatting analysis

• Content completeness and consistency checks

• Performance and readability assessments

• Custom analysis workflows and reporting Key features:

• Asynchronous analysis processing for large documents

• Real-time analysis status tracking and progress updates

• Detailed analysis reports with actionable insights

• Historical analysis data and trend tracking

• Integration with document review workflows

• Export capabilities for analysis results All analysis operations are team-scoped and maintain comprehensive audit trails.

Endpoints

List analysis

List analysis reports

Retrieve a paginated list of analysis reports for documents in the authenticated team. Returns suggestion reports with document information and analysis metrics.

Endpoint: GET /api/v1/analysis

Examples:

curl -X GET "https://simplistica.co/api/v1/analysis?limit=20&page=1" \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Content-Type: application/json"

Query Parameters:

• limit (integer) Optional (default: 20) - Number of items to return
• page (integer) Optional (default: 1) - Page number for pagination (starts from 1)

Response Schema:

Example Response:

{
  "path": "/api/v1/analysis",
  "version": "v1",
  "timestamp": "2025-01-27T10:30:00.000Z",
  "data": {
    "data": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "title": "example_title",
        "type": "document",
        "reviewStatus": "draft",
        "createdAt": "2025-01-27T10:30:00.000Z",
        "updatedAt": "2025-01-27T10:30:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "hasNextPage": true,
      "prevPage": null,
      "nextPage": "https://simplistica.co/api/v1/documents?limit=20&page=2"
    }
  }
}

Responses:

• 200: Success
• 400: Bad Request
• 401: Unauthorized
• 500: Internal Server Error

Get analysis for document

Get document analysis results

Retrieve the completed analysis results for a specific document. Returns the most recent completed suggestion report with analysis data and document information.

Endpoint: GET /api/v1/analysis/{document-id}

Examples:

curl -X GET "https://simplistica.co/api/v1/analysis/{document-id}?limit=20&page=1" \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Content-Type: application/json"

Parameters:

Path Parameters:

• document-id (string) Required - The document-id of the resource

Query Parameters:

• limit (integer) Optional (default: 20) - Number of items to return
• page (integer) Optional (default: 1) - Page number for pagination (starts from 1)

Response Schema:

Example Response:

{
  "path": "/api/v1/analysis/{document-id}",
  "version": "v1",
  "timestamp": "2025-01-27T10:30:00.000Z",
  "data": {
    "data": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "title": "example_title",
        "type": "document",
        "reviewStatus": "draft",
        "createdAt": "2025-01-27T10:30:00.000Z",
        "updatedAt": "2025-01-27T10:30:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "hasNextPage": true,
      "prevPage": null,
      "nextPage": "https://simplistica.co/api/v1/documents?limit=20&page=2"
    }
  }
}

Responses:

• 200: Success
• 400: Bad Request
• 401: Unauthorized
• 404: Not Found
• 500: Internal Server Error

Run analysis

POST operation for analysis

Endpoint: POST /api/v1/analysis/run

Examples:

curl -X POST "https://simplistica.co/api/v1/analysis/run" \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "documentId": "123e4567-e89b-12d3-a456-426614174000"
     }'

Request Body Schema:

Response Schema:

Example Response:

{
  "path": "/api/v1/analysis/run",
  "version": "v1",
  "timestamp": "2025-01-27T10:30:00.000Z",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": "example_title",
    "content": "example_content",
    "type": "document",
    "reviewStatus": "draft",
    "createdAt": "2025-01-27T10:30:00.000Z",
    "updatedAt": "2025-01-27T10:30:00.000Z"
  }
}

Responses:

• 200: Success
• 400: Bad Request
• 401: Unauthorized
• 500: Internal Server Error

Response Examples

Success Response

{
  "path": "/api/v1/analysis",
  "version": "v1",
  "timestamp": "2025-01-27T10:30:00.000Z",
  "data": null,
  "message": "Operation completed successfully"
}

Error Response

{
  "path": "/api/v1/analysis",
  "version": "v1",
  "timestamp": "2025-01-27T10:30:00.000Z",
  "error": "Validation Error",
  "message": "Required field 'email' is missing"
}

Common HTTP Status Codes

• 200: Success
• 201: Created
• 400: Bad Request (validation error)
• 401: Unauthorized (invalid or missing token)
• 404: Not Found (resource doesn’t exist)
• 429: Too Many Requests (rate limit exceeded)
• 500: Internal Server Error