HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept
{
"next": null,
"previous": null,
"results": [
{
"id": 29,
"user": 1,
"organization": null,
"access": "public",
"name": "SideKick",
"repository": "MuckRock/documentcloud-sidekick-addon",
"parameters": {
"type": "object",
"title": "SideKick",
"required": [
"tag_name"
],
"documents": [
"query"
],
"categories": [
"ai"
],
"properties": {
"tag_name": {
"type": "string",
"title": "Value to Train"
},
"initialize": {
"type": "boolean",
"title": "Force Initialize"
}
},
"description": "<p>SideKick is machine learning tool designed to help you quickly test ways to categorize large documents sets, apply machine learning to try to sort documents into one set or another, and get feedback on how well the model works. We’re working on launching an improved, real-time graphical categorization tool, but in the meantime, this Add-On will let you get started.</p>\n<h1>Step 1:</h1>\n<p>Select a project on the left-hand sidebar before running this Add-On. If you need to, click <em>Cancel</em>, select a project, and start SideKick again.</p>\n<h1>Step 2:</h1>\n<p>Use DocumentCloud’s <em>Edit->Edit Document Data</em> feature to add a key value pair with the category you want, with about five examples of documents that match a category and five that don’t. For example, you might add a key of <em>Email</em> with five documents set to <em>True</em> and five set to <em>False</em>. Since <em>Email</em> is the value you’re training on, set it as the <em>Value to Train</em> below. SideKick is a binary classifier — it will try to rank all documents on a spectrum from -1 to 1 based on how likely it believe the document is to be that value.</p>"
},
"created_at": "2022-04-20T13:41:22.107224Z",
"updated_at": "2023-08-18T15:36:09.012200Z",
"active": false,
"default": false,
"featured": false
},
{
"id": 30,
"user": 1,
"organization": null,
"access": "public",
"name": "Bulk Edit",
"repository": "MuckRock/documentcloud-bulk-edit-addon",
"parameters": {
"type": "object",
"title": "Bulk Edit",
"version": 2,
"documents": [
"query"
],
"categories": [
"bulk"
],
"properties": {
"source": {
"type": "string",
"title": "Source"
},
"description": {
"type": "string",
"title": "Description"
},
"published_url": {
"type": "string",
"title": "Published URL",
"format": "uri"
},
"related_article": {
"type": "string",
"title": "Related Article URL",
"format": "uri"
}
},
"description": "<p>This will update document information for all documents in your current search. Please be sure you have edit access to these documents before running this add-on.</p>"
},
"created_at": "2022-04-20T13:41:22.119412Z",
"updated_at": "2024-11-25T16:08:47.884584Z",
"active": false,
"default": false,
"featured": false
},
{
"id": 31,
"user": 1,
"organization": null,
"access": "public",
"name": "Regex Extractor",
"repository": "MuckRock/documentcloud-regex-addon",
"parameters": {
"type": "object",
"title": "Regex Extractor",
"required": [
"regex"
],
"documents": [
"selected"
],
"categories": [
"extraction"
],
"properties": {
"regex": {
"type": "string",
"title": "Regex",
"format": "regex"
}
},
"description": "<p>This will return a JSON file of all strings the given regex matches in the selected files</p>"
},
"created_at": "2022-04-20T13:41:22.130839Z",
"updated_at": "2024-11-25T16:08:48.970909Z",
"active": false,
"default": false,
"featured": false
},
{
"id": 32,
"user": 1,
"organization": null,
"access": "public",
"name": "PDF Exporter",
"repository": "MuckRock/documentcloud-pdf-export-addon",
"parameters": {
"type": "object",
"title": "PDF Exporter",
"documents": [
"selected",
"query"
],
"categories": [
"export"
],
"properties": {},
"description": "<p>Export the selected PDFs in a zip file. </p>\n<p><strong>Note:</strong> If you run this Add-On on a large set of documents and the zip file grows larger than 5GB, you will get a failure. Retry on a smaller set of documents or break up the larger set into smaller subsets. </p>"
},
"created_at": "2022-04-20T13:41:22.142267Z",
"updated_at": "2025-04-10T18:54:58.320120Z",
"active": false,
"default": false,
"featured": false
},
{
"id": 33,
"user": 1,
"organization": null,
"access": "public",
"name": "Note Exporter",
"repository": "MuckRock/documentcloud-note-export-addon",
"parameters": {
"type": "object",
"title": "Note Exporter",
"documents": [
"selected"
],
"categories": [
"export"
],
"properties": {},
"description": "<p>Export notes from the selected documents as text files in a zip file</p>"
},
"created_at": "2022-04-20T13:41:22.154658Z",
"updated_at": "2024-11-17T01:38:24.441819Z",
"active": false,
"default": false,
"featured": false
},
{
"id": 36,
"user": 1,
"organization": null,
"access": "public",
"name": "Scraper",
"repository": "MuckRock/documentcloud-scraper-addon",
"parameters": {
"type": "object",
"title": "Scraper",
"required": [
"site",
"project"
],
"categories": [
"monitor"
],
"properties": {
"site": {
"type": "string",
"title": "Site",
"format": "uri",
"description": "The URL of the site to start scraping"
},
"project": {
"type": "string",
"title": "Project",
"description": "The DocumentCloud project title or ID of the project the documents should be uploaded to. If the project title does not exist, it will be created."
},
"filecoin": {
"type": "boolean",
"title": "Push to IPFS/Filecoin",
"description": "WARNING: This will push all scraped files to IPFS and Filecoin. There is no way to remove files from these storage systems."
},
"keywords": {
"type": "string",
"title": "Keywords",
"description": "Keywords to search and notify on (comma separated)"
},
"notify_all": {
"type": "boolean",
"title": "Notify on all new documents"
},
"crawl_depth": {
"type": "integer",
"title": "Crawl Depth",
"default": 0,
"maximum": 2,
"minimum": 0,
"description": "Recursively scrape same-domain links found on the page (Must be between 0 and 2)"
},
"access_level": {
"enum": [
"public",
"organization",
"private"
],
"type": "string",
"title": "Access Level",
"default": "public",
"description": "Access level of documents scraped."
},
"slack_webhook": {
"type": "string",
"title": "Slack Webhook",
"format": "uri",
"description": "Enter a slack webhook to enable Slack notifications"
}
},
"description": "<p>Scrape and optionally crawl a given site for documents to upload to DocumentCloud.</p>",
"eventOptions": {
"name": "site",
"events": [
"hourly",
"daily",
"weekly"
]
},
"instructions": "<p>You may specify a project to scrape the documents into as well as an access level. \nScraper can alert you by email or Slack notification when given keywords appear in\ndocuments if you specify keywords to monitor. For Slack notifications, you must provide a webhook. </p>\n<p>The crawl depth is a parameter that tells the Scraper how many clicks deep away from the\nsite you specify in order to continue looking for documents. \nIf the PDFs are directly linked on the site you provide \n(1 click to get to the PDF), 0 is the crawl depth you should use. \nIf the site you provide a link to contains multiple links to other pages that have PDFs linked to those pages, \nyour crawl depth would be 1. A crawl depth of 2 is the maximum supported. </p>\n<p>The Scraper Add-On now supports Google Drive links. \nIt will upload the first 30 Google Drive documents it sees per run. \nScraper will upload the first 100 regular documents it sees per run. \nThe Scraper keeps track of which documents it has seen and already uploaded.</p>",
"custom_disabled_email_footer": "The Scraper Add-On may fail for many reasons. \nA few reasons it might fail are that a site may rely heavily on Javascript to interact with the page, \nthe site may have bugs with HTTPS support on their site, or the site obfuscates where the documents that are downloaded are located. \nThis a sample footer for customized Add-On disable emails. Read more about DocumentCloud Add-Ons: https://documentcloud.org/help/faq\n"
},
"created_at": "2022-05-09T14:10:00.369913Z",
"updated_at": "2024-11-22T21:47:17.945966Z",
"active": false,
"default": false,
"featured": true
},
{
"id": 40,
"user": null,
"organization": 1,
"access": "public",
"name": "Extract & Tag Add-On",
"repository": "MuckRock/Extract-Tag-AddOn",
"parameters": {
"type": "object",
"title": "Extract & Tag Add-On",
"version": 2,
"required": [
"start",
"end",
"key_name"
],
"documents": [
"query",
"selected"
],
"categories": [
"extraction"
],
"properties": {
"end": {
"type": "string",
"title": "End String"
},
"start": {
"type": "string",
"title": "Start String"
},
"key_name": {
"type": "string",
"title": "Key Name"
}
},
"description": "<p>When provided a selection or query of DocumentCloud documents, this Add-On extracts the text from a document starting from a given start string to a given end string, basically automating a copy-paste procedure. It also allows you to pick a key name for it if you want to add it as a key/value pair on DocumentCloud.</p>",
"instructions": " I am here as a [tester](https://documentcloud.org)"
},
"created_at": "2023-01-25T22:29:05.890993Z",
"updated_at": "2024-04-11T18:56:01.693188Z",
"active": false,
"default": false,
"featured": false
},
{
"id": 45,
"user": null,
"organization": null,
"access": "public",
"name": "Google Cloud Vision OCR",
"repository": "MuckRock/documentcloud-cloud-vision-ocr",
"parameters": {
"cost": {
"unit": "page",
"price": 1,
"amount": 1
},
"type": "object",
"title": "Google Cloud Vision OCR",
"version": 2,
"documents": [
"selected"
],
"categories": [
"extraction",
"premium"
],
"properties": {
"to_tag": {
"type": "boolean",
"title": "Tag OCR'd documents?",
"description": "If selected, the key/value pair of ocr_engine:google will be added to the document as metadata"
}
},
"description": "<p>OCR your documents using Google Cloud Vision OCR. </p>",
"instructions": ""
},
"created_at": "2023-09-18T17:09:58.082953Z",
"updated_at": "2025-02-14T15:50:05.069486Z",
"active": false,
"default": false,
"featured": false
},
{
"id": 46,
"user": null,
"organization": null,
"access": "public",
"name": "Azure Document Intelligence OCR",
"repository": "MuckRock/documentcloud-azure-document-intelligence-ocr-addon",
"parameters": {
"cost": {
"unit": "page",
"price": 1,
"amount": 1
},
"type": "object",
"title": "Azure Document Intelligence OCR",
"version": 2,
"documents": [
"selected"
],
"categories": [
"extraction",
"premium"
],
"properties": {
"to_tag": {
"type": "boolean",
"title": "Tag OCR'd documents?",
"description": "If selected, the key/value pair of ocr_engine:azure will be added to the document as metadata"
}
},
"description": "<p>This Add-On uses Azure’s Document Intelligence API to OCR documents.</p>",
"instructions": ""
},
"created_at": "2023-09-18T17:09:58.097621Z",
"updated_at": "2025-03-07T19:48:26.653889Z",
"active": false,
"default": false,
"featured": false
},
{
"id": 47,
"user": null,
"organization": null,
"access": "public",
"name": "Bulk Add to Project",
"repository": "MuckRock/bulk-add-to-project-add-on",
"parameters": {
"type": "object",
"title": "Bulk Add to Project",
"version": 2,
"required": [
"project_id"
],
"documents": [
"query"
],
"categories": [
"bulk"
],
"properties": {
"project_id": {
"type": "integer",
"title": "Project ID"
}
},
"description": "<p>This DocumentCloud Add-On allows you to add a query of documents to a project.</p>"
},
"created_at": "2024-05-08T18:33:02.245652Z",
"updated_at": "2024-05-08T18:41:47.803762Z",
"active": false,
"default": false,
"featured": false
},
{
"id": 48,
"user": 1,
"organization": null,
"access": "public",
"name": "Klaxon Cloud: Site Monitor and Alerts",
"repository": "MuckRock/Klaxon",
"parameters": {
"type": "object",
"title": "Klaxon Cloud: Site Monitor and Alerts",
"required": [
"site",
"selector"
],
"categories": [
"monitor"
],
"properties": {
"site": {
"type": "string",
"title": "Site",
"format": "uri"
},
"selector": {
"type": "string",
"title": "Selector",
"description": "CSS Selector on the page you would like to monitor."
},
"slack_webhook": {
"type": "string",
"title": "Slack Webhook",
"format": "uri",
"description": "Enter a slack webhook to enable Slack notifications"
},
"filter_selector": {
"type": "string",
"title": "Filter",
"description": "Optional HTML tag that you want to filter out from being compared. Ex: Type a for <a> tags"
}
},
"description": "<p>Klaxon enables reporters and editors to monitor scores of sites and files on the web for newsworthy changes. Get email notifications when something changes. Provide a CSS selector to only monitor portions of a page you are interested in. You may supply * to monitor the entire page, but you may receive alerts for trivial changes. Email alerts are sent to the primary email address on your DocumentCloud account. To get started, copy the bookmarklet <a href=\"javascript:(function(){document.body.appendChild(document.createElement('script')).src='https://documentcloud-klaxon.s3.amazonaws.com/inject.js';})();\">Add to Klaxon</a> to your bookmarks, visit a page you are looking to monitor, and then click on the bookmark to activate Klaxon. </p>",
"eventOptions": {
"name": "site",
"events": [
"hourly",
"daily",
"weekly"
]
},
"instructions": ""
},
"created_at": "2024-11-07T15:44:53.587225Z",
"updated_at": "2024-11-17T01:38:26.271143Z",
"active": false,
"default": true,
"featured": true
},
{
"id": 114,
"user": null,
"organization": null,
"access": "public",
"name": "Textract OCR",
"repository": "MuckRock/documentcloud-textract-ocr-addon",
"parameters": {
"cost": {
"unit": "page",
"price": 1,
"amount": 1
},
"type": "object",
"title": "Textract OCR",
"documents": [
"selected"
],
"categories": [
"extraction",
"premium"
],
"properties": {
"to_tag": {
"type": "boolean",
"title": "Tag OCR'd documents?",
"description": "If selected, the key/value pair of ocr_engine:textract will be added to the document as metadata"
}
},
"description": "<p>This Add-On uses Amazon Textract to OCR documents.</p>",
"instructions": ""
},
"created_at": "2025-02-12T21:32:47.054045Z",
"updated_at": "2025-02-13T17:01:39.842095Z",
"active": false,
"default": false,
"featured": false
}
]
}