Skip to main content

​
Overview

Work products are documents (requirements, specifications, test cases, etc.) that are analyzed for compliance against standards.

​
List Work Products

curl -X GET "https://api.conformly.ai/api/v1/work-products?cursor=&limit=20&type=&search=" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

{
  "items": [
    {
      "id": "uuid",
      "workspace_id": "uuid",
      "name": "System Requirements Spec.pdf",
      "original_filename": "SRS.pdf",
      "file_url": "https://storage...",
      "file_size": 2345678,
      "file_type": "application/pdf",
      "category": "requirements",
      "uploaded_at": "2025-01-01T00:00:00Z",
      "processing_status": "completed",
      "compliance_score": 85.5,
      "tags": ["project-x", "v2.0"]
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 20,
  "next_cursor": null
}

​
Initialize Work Product Upload

curl -X POST "https://api.conformly.ai/api/v1/work-products/uploads/init" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -F "filename=document.pdf" \
  -F "size=1234567" \
  -F "content_type=application/pdf" \
  -F "workspace_id=uuid"

​
Complete Work Product Upload

curl -X POST "https://api.conformly.ai/api/v1/work-products/uploads/{file_id}/complete" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"