# Automat | Documentation

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runautomat.com/_mcp/server

## Docs

- [Introduction](https://docs.runautomat.com/guides/getting-started/introduction.md): Intelligent document data extraction powered by AI
- [Authentication](https://docs.runautomat.com/guides/getting-started/authentication.md): Secure your API requests with API keys
- [Quickstart](https://docs.runautomat.com/guides/getting-started/quickstart.md): Extract data from your first document in under 5 minutes
- [Extractors](https://docs.runautomat.com/guides/concepts/extractors.md): Configure what data to extract from your documents
- [Schemas](https://docs.runautomat.com/guides/concepts/schemas.md): Define the structure of your extracted data

## API Docs

- Extract > Extract [Extract Document](https://docs.runautomat.com/api-reference/extract/extract/extract/extract.md)
- Programmatic Access API > packages [List active packages available for project selection](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/packages/catalog.md)
- Programmatic Access API > packages [List packages selected for a project](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/packages/list.md)
- Programmatic Access API > packages [Select an active package for a project](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/packages/add.md)
- Programmatic Access API > packages [Remove a package selection from a project](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/packages/remove.md)
- Programmatic Access API > projects [List projects available to the token](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/projects/list.md)
- Programmatic Access API > projects [Create a project](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/projects/create.md)
- Programmatic Access API > projects [Get one project available to the token](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/projects/get.md)
- Programmatic Access API > projects [Soft-delete a confirmed project](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/projects/delete.md)
- Programmatic Access API > browser_sessions [List Browser Sessions](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/browser-sessions/list.md)
- Programmatic Access API > browser_sessions [Create a Browser Session](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/browser-sessions/create.md)
- Programmatic Access API > browser_sessions [Revoke a Browser Session](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/browser-sessions/revoke.md)
- Programmatic Access API > collaboration [Mint an upload slot for a comment attachment](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/mint-comment-attachment.md)
- Programmatic Access API > collaboration [Confirm an uploaded comment attachment](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/confirm-comment-attachment.md)
- Programmatic Access API > collaboration [List colleagues a review may be handed to](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/list-handoff-targets.md)
- Programmatic Access API > collaboration [Open a review on a session](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/create-review.md)
- Programmatic Access API > collaboration [List review threads on a session](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/list-threads.md)
- Programmatic Access API > collaboration [Mark a thread as seen](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/acknowledge.md)
- Programmatic Access API > collaboration [Withdraw your acknowledgement of a thread](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/clear-acknowledgement.md)
- Programmatic Access API > collaboration [Read a page of a thread’s comments](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/list-comments.md)
- Programmatic Access API > collaboration [Post a comment on a thread](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/create-comment.md)
- Programmatic Access API > collaboration [Withdraw your own comment](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/delete-comment.md)
- Programmatic Access API > collaboration [Edit your own comment inside its edit window](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/update-comment.md)
- Programmatic Access API > collaboration [Resolve or reopen a review](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/update-review.md)
- Programmatic Access API > collaboration [Hand an open review to a colleague on your own side](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/update-waiting-on.md)
- Programmatic Access API > collaboration [List the reviews inbox](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/list-reviews.md)
- Programmatic Access API > collaboration [Count open reviews waiting on your side](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/count-reviews.md)
- Programmatic Access API > collaboration [Clear unread inbox rows](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/collaboration/mark-reviews-read.md)
- Programmatic Access API > credentials [List project credential metadata without values](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/credentials/list.md)
- Programmatic Access API > credentials [Create or fully replace a write-only managed credential](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/credentials/put.md)
- Programmatic Access API > credentials [Delete a credential using optimistic concurrency](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/credentials/delete.md)
- Programmatic Access API > credentials [Patch write-only credential fields with optimistic concurrency](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/credentials/patch.md)
- Programmatic Access API > extractors [List project extractors](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/list.md)
- Programmatic Access API > extractors [Create an extractor and initial version](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/create.md)
- Programmatic Access API > extractors [Read an extractor and current version](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/get.md)
- Programmatic Access API > extractors [Soft-delete an extractor](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/delete.md)
- Programmatic Access API > extractors [Update an extractor by creating a new version](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/update.md)
- Programmatic Access API > extractors [List confirmed documents associated with an extractor](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/documents.md)
- Programmatic Access API > extractors [Prepare a direct upload for an extractor document](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/upload-document.md)
- Programmatic Access API > extractors [Remove an associated extractor document](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/remove-document.md)
- Programmatic Access API > extractors [Queue a durable extraction-history export job](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/export.md)
- Programmatic Access API > extractors [Read one durable extractor job](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/get-job.md)
- Programmatic Access API > extractors [Cancel a queued or running extractor job](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/cancel-job.md)
- Programmatic Access API > extractors [Run an extractor against a project storage path](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/run.md)
- Programmatic Access API > extractors [List extraction summaries](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/history.md)
- Programmatic Access API > extractors [Queue an extraction job for an associated document](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/queue-run.md)
- Programmatic Access API > extractors [Read one extraction result](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/get-run.md)
- Programmatic Access API > extractors [Queue a durable extractor schema-generation job](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/generate-schema.md)
- Programmatic Access API > extractors [List extractor version metadata](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/versions.md)
- Programmatic Access API > extractors [Publish and activate an extractor version](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/publish.md)
- Programmatic Access API > extractors [Read an extractor version](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/extractors/get-version.md)
- Programmatic Access API > files [Prepare a direct project file upload](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/files/prepare-upload.md)
- Programmatic Access API > files [Get project file metadata](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/files/get.md)
- Programmatic Access API > files [Delete a non-audit workflow file](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/files/delete.md)
- Programmatic Access API > files [Mint a fresh project file reference](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/files/resign.md)
- Programmatic Access API > files [Resolve project file references](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/files/availability.md)
- Programmatic Access API > files [Confirm a direct project file upload](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/files/confirm-upload.md)
- Programmatic Access API > files [Import a bounded HTTPS object](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/files/import-https.md)
- Programmatic Access API > hitl [List visible human tasks](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/hitl/list-tasks.md)
- Programmatic Access API > hitl [Complete a pending human task](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/hitl/complete-task.md)
- Programmatic Access API > library [List curated project files](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/library/list.md)
- Programmatic Access API > library [Register an uploaded curated file](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/library/register.md)
- Programmatic Access API > library [Get a curated file reference](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/library/get-reference.md)
- Programmatic Access API > library [Delete a curated project file](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/library/delete.md)
- Programmatic Access API > library [Copy a ledger file into the curated library](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/library/promote.md)
- Programmatic Access API > library [Prepare a curated file upload](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/library/prepare-upload.md)
- Programmatic Access API > resources [List project data resources](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/resources/list.md)
- Programmatic Access API > resources [Create project data resources](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/resources/create.md)
- Programmatic Access API > resources [Read a project data resource](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/resources/get.md)
- Programmatic Access API > resources [Replace a data resource value and source configuration](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/resources/put.md)
- Programmatic Access API > resources [Soft-delete a data resource](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/resources/delete.md)
- Programmatic Access API > resources [Set resource visibility for authors and members](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/resources/visibility.md)
- Programmatic Access API > resources [Safely preview a JSON resource endpoint](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/resources/test-fetch.md)
- Programmatic Access API > sessions [List visible workflow sessions](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/sessions/list.md)
- Programmatic Access API > sessions [Read session input, output, status, and recording URL](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/sessions/get.md)
- Programmatic Access API > sessions [Read retained logs for the latest session attempt](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/sessions/get-logs.md)
- Programmatic Access API > sessions [Read the latest-attempt node timeline and I/O](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/sessions/list-nodes.md)
- Programmatic Access API > sessions [Read bounded latest-attempt session replay data](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/sessions/replay.md)
- Programmatic Access API > sessions [Cancel a non-terminal session](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/sessions/stop.md)
- Programmatic Access API > sessions [Read multiple session details by id](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/sessions/bulk-get.md)
- Programmatic Access API > workflow_intake [List customer-managed credential metadata](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-credentials-list.md)
- Programmatic Access API > workflow_intake [Create a write-only customer-managed credential](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-credentials-create.md)
- Programmatic Access API > workflow_intake [Delete a customer-managed credential and its stored value](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-credentials-delete.md)
- Programmatic Access API > workflow_intake [Submit or resubmit write-only credential values while requested or in review](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-credentials-submit.md)
- Programmatic Access API > workflow_intake [Request, cancel, return, or accept a customer credential](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-credentials-transition.md)
- Programmatic Access API > workflow_intake [Pre-create a customer credential request](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-credentials-create-requested.md)
- Programmatic Access API > workflow_intake [Delete a customer-managed file blob and intake row](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-files-delete.md)
- Programmatic Access API > workflow_intake [Create a short-lived customer-safe file reference](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-files-sign.md)
- Programmatic Access API > workflow_intake [Confirm an upload for a requested or in-review file, or create an unmatched pending file](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-files-confirm.md)
- Programmatic Access API > workflow_intake [Prepare a direct customer file upload](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-files-prepare-upload.md)
- Programmatic Access API > workflow_intake [List member-visible project resources across all sources and stages](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-resources-list.md)
- Programmatic Access API > workflow_intake [Create a customer-managed data resource](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-resources-create.md)
- Programmatic Access API > workflow_intake [Read a member-visible project resource with private configuration removed](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-resources-get.md)
- Programmatic Access API > workflow_intake [Submit or resubmit customer-managed data that is requested or in review](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-resources-submit.md)
- Programmatic Access API > workflow_intake [Return or accept a pending customer resource](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-resources-transition.md)
- Programmatic Access API > workflow_intake [Pre-create a customer data or file request](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflow-intake/intake-resources-create-requested.md)
- Programmatic Access API > workflows [List workflow metadata](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflows/list.md)
- Programmatic Access API > workflows [Create a workflow and its first version](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflows/create.md)
- Programmatic Access API > workflows [Read a workflow projection](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflows/get.md)
- Programmatic Access API > workflows [Append and activate a workflow definition version](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflows/put-definition.md)
- Programmatic Access API > workflows [Soft-delete a workflow](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflows/delete.md)
- Programmatic Access API > workflows [Update workflow metadata and lifecycle](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflows/update.md)
- Programmatic Access API > workflows [Clone the active version into a new development workflow](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflows/clone.md)
- Programmatic Access API > workflows [Trigger a workflow run](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflows/run.md)
- Programmatic Access API > workflows [Validate the active workflow definition without dispatching](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/workflows/validate.md)
- Programmatic Access API > schedules [List workflow schedules](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/schedules/list.md)
- Programmatic Access API > schedules [Create a workflow schedule](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/schedules/create.md)
- Programmatic Access API > schedules [Soft-delete a workflow schedule](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/schedules/delete.md)
- Programmatic Access API > schedules [Update a workflow schedule](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/schedules/update.md)
- Programmatic Access API > versions [List workflow version metadata](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/versions/list.md)
- Programmatic Access API > versions [Read a workflow version definition](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/versions/get.md)
- Programmatic Access API > versions [Append a version that restores an earlier definition](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/versions/revert.md)
- Programmatic Access API > versions [Count runs by outcome for a workflow version](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/versions/run-summary.md)
- Programmatic Access API > runtime_versions [List available Runtime versions](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/runtime-versions/list.md)
- Programmatic Access API > runtime_versions [List safe Trigger instance choices](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/runtime-versions/list-trigger-instances.md)
- Programmatic Access API > runtime_versions [List eligible worker groups](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/runtime-versions/list-worker-groups.md)
- Programmatic Access API > schema [Read the installed workflow schema and authoring contract](https://docs.runautomat.com/api-reference/programmatic-access/programmatic-access-api/schema/get-workflow.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.runautomat.com/openapi.json)
- [OpenAPI YAML](https://docs.runautomat.com/openapi.yaml)