Queue Project Analysis
queue_project_analysisStart a background batch analysis to process multiple documents from a project at once, then track progress or cancel as needed.
Instructions
Enqueue a background batch analysis across many documents at once and return a job id immediately. Poll progress with get_job_status and stop it with cancel_job. Use this to analyze a whole manuscript or large set of documents; for a single document prefer queue_document_analysis or the synchronous analyze_document.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| options | No | Optional batch execution settings. | |
| documents | Yes | Array of documents (id and content) to include in the batch analysis. | |
| projectId | Yes | Identifier of the project the documents belong to. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| jobId | Yes | Identifier of the queued batch job; poll it with get_job_status. |