Loading...
Loading...
Interact with Paperless-ngx document management system via REST API. Use when users want to search, upload, download, organize documents, manage tags, correspondents, or document types in their Paperless-ngx instance.
npx skill4agent add sundial-org/awesome-openclaw-skills paperless-ngxPAPERLESS_URLhttps://paperless.example.comPAPERLESS_TOKENAuthorization: Token $PAPERLESS_TOKENcurl -s "$PAPERLESS_URL/api/documents/?query=invoice" \
-H "Authorization: Token $PAPERLESS_TOKEN"correspondent__iddocument_type__idtags__id__increated__date__gtecreated__date__lteadded__date__gtecurl -s "$PAPERLESS_URL/api/documents/{id}/" \
-H "Authorization: Token $PAPERLESS_TOKEN"# Original file
curl -s "$PAPERLESS_URL/api/documents/{id}/download/" \
-H "Authorization: Token $PAPERLESS_TOKEN" -o document.pdf
# Archived (OCR'd) version
curl -s "$PAPERLESS_URL/api/documents/{id}/download/?original=false" \
-H "Authorization: Token $PAPERLESS_TOKEN" -o document.pdfcurl -s "$PAPERLESS_URL/api/documents/post_document/" \
-H "Authorization: Token $PAPERLESS_TOKEN" \
-F "document=@/path/to/file.pdf" \
-F "title=Document Title" \
-F "correspondent=1" \
-F "document_type=2" \
-F "tags=3" \
-F "tags=4"titlecreatedcorrespondentdocument_typestorage_pathtagsarchive_serial_numbercustom_fieldscurl -s -X PATCH "$PAPERLESS_URL/api/documents/{id}/" \
-H "Authorization: Token $PAPERLESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"title": "New Title", "correspondent": 1, "tags": [1, 2]}'curl -s -X DELETE "$PAPERLESS_URL/api/documents/{id}/" \
-H "Authorization: Token $PAPERLESS_TOKEN"# List tags
curl -s "$PAPERLESS_URL/api/tags/" -H "Authorization: Token $PAPERLESS_TOKEN"
# Create tag
curl -s -X POST "$PAPERLESS_URL/api/tags/" \
-H "Authorization: Token $PAPERLESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "Important", "color": "#ff0000"}'# List correspondents
curl -s "$PAPERLESS_URL/api/correspondents/" -H "Authorization: Token $PAPERLESS_TOKEN"
# Create correspondent
curl -s -X POST "$PAPERLESS_URL/api/correspondents/" \
-H "Authorization: Token $PAPERLESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "ACME Corp"}'# List document types
curl -s "$PAPERLESS_URL/api/document_types/" -H "Authorization: Token $PAPERLESS_TOKEN"
# Create document type
curl -s -X POST "$PAPERLESS_URL/api/document_types/" \
-H "Authorization: Token $PAPERLESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "Invoice"}'curl -s -X POST "$PAPERLESS_URL/api/documents/bulk_edit/" \
-H "Authorization: Token $PAPERLESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"documents": [1, 2, 3],
"method": "add_tag",
"parameters": {"tag": 5}
}'set_correspondentset_document_typeadd_tagremove_tagdeletereprocesscurl -s "$PAPERLESS_URL/api/tasks/?task_id={uuid}" \
-H "Authorization: Token $PAPERLESS_TOKEN"{"count": N, "results": [...]}?page=2?ordering=-created-