{
  "opencollection": "1.0.0",
  "info": {
    "name": "Luminary Documents API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "https://auth.withluminary.com/oauth2/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all document summaries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/document-summaries",
            "params": [
              {
                "name": "household_id",
                "value": "",
                "type": "query",
                "description": "Filter summaries by household ID"
              },
              {
                "name": "document_id",
                "value": "",
                "type": "query",
                "description": "Filter summaries by document ID"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Cursor for forward pagination. Returns items after this cursor."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Cursor for backward pagination. Returns items before this cursor."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to return"
              }
            ]
          },
          "docs": "Retrieve a paginated list of document summaries using cursor-based pagination"
        },
        {
          "info": {
            "name": "Get a document summary by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/document-summaries/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Document Summary ID"
              }
            ]
          },
          "docs": "Retrieve a specific document summary"
        },
        {
          "info": {
            "name": "Update a document summary",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/document-summaries/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Document Summary ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing document summary"
        },
        {
          "info": {
            "name": "Download document summary as PDF",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/document-summaries/:id/download",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Document Summary ID"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "Output format for the download"
              }
            ]
          },
          "docs": "Download the document summary content in the specified format"
        },
        {
          "info": {
            "name": "List all documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/documents",
            "params": [
              {
                "name": "household_id",
                "value": "",
                "type": "query",
                "description": "Filter documents by household ID"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Filter by document type"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Cursor for forward pagination. Returns items after this cursor."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Cursor for backward pagination. Returns items before this cursor."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to return"
              }
            ]
          },
          "docs": "Retrieve a paginated list of documents using cursor-based pagination"
        },
        {
          "info": {
            "name": "Upload a new document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/documents",
            "body": {
              "type": "multipart-form",
              "data": []
            }
          },
          "docs": "Create a new document with file content"
        },
        {
          "info": {
            "name": "Get a document by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/documents/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Document ID"
              }
            ]
          },
          "docs": "Retrieve document metadata"
        },
        {
          "info": {
            "name": "Update a document",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/documents/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Document ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update document metadata only"
        },
        {
          "info": {
            "name": "Delete a document",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/documents/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Document ID"
              }
            ]
          },
          "docs": "Soft delete a document (marks as deleted but preserves data)"
        },
        {
          "info": {
            "name": "Get summaries for a document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/documents/:id/document-summaries",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Document ID"
              }
            ]
          },
          "docs": "Retrieve all summaries associated with a specific document"
        },
        {
          "info": {
            "name": "Download document file content",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/documents/:id/download",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Document ID"
              }
            ]
          },
          "docs": "Download the binary content of the document file"
        },
        {
          "info": {
            "name": "List all documents in a household",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/households/:id/documents",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Household ID"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Filter by document type"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Cursor for forward pagination. Returns items after this cursor."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Cursor for backward pagination. Returns items before this cursor."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to return"
              }
            ]
          },
          "docs": "Retrieve a paginated list of documents belonging to a specific household"
        }
      ]
    }
  ],
  "bundled": true
}