Adobe Suite Document API

The Document API from Adobe Suite — 32 operation(s) for document.

Documentation GitHub OpenAPI

Operations 37

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /document/{id} Get one Workfront document · Get for Document #

Ask an LLM

“How do I look up a single document by its ID in Workfront?”

“Can I choose which fields come back when fetching one document?”

Tell an agent

Get document {id}.

Fetch document {id} with only the fields {fields}.

PUT /document/{id} Edit a document's details · Edit a Document #

Ask an LLM

“How do I change the name or description of one existing document?”

“Can I update a single document and get specific fields back in the response?”

Tell an agent

Edit document {id} with the new values I give you.

Update document {id} and return the fields {fields}.

DELETE /document/{id} Delete a document · Delete for Document #

Ask an LLM

“What's the call to permanently delete one document from Workfront?”

“Is there a way to force-delete a document that won't delete normally?”

Tell an agent destructive · confirm first

Delete document {id}.

Force-delete document {id} with force set to {force}.

GET /document Get several documents by ID at once · Bulk Get for Document #

Ask an LLM

“Can I fetch a batch of documents in one call if I have their IDs?”

“What's the way to retrieve multiple documents together instead of one by one?”

Tell an agent

Get the documents with IDs {ids}.

Bulk-fetch documents {ids} returning just {fields}.

PUT /document Edit many documents in one request · Bulk Edit for Document #

Ask an LLM

“Can I update a whole batch of documents in a single request?”

“How do I bulk edit documents rather than editing each one?”

Tell an agent

Bulk edit the documents I list with the changes I provide.

Apply my edits to several documents at once and return {fields}.

POST /document Create a document · Create a document #

Ask an LLM

“How do I add a new document record in Workfront?”

“Can I create a document and choose which of its fields are returned?”

Tell an agent

Create a new document with the details I give you.

Add a document and return its {fields}.

DELETE /document Delete several documents at once · Bulk Delete for Document #

Ask an LLM

“Can I delete a batch of documents in one call?”

“Is there a bulk delete for documents by their IDs?”

Tell an agent destructive · confirm first

Delete the documents with IDs {ids}.

Bulk force-delete documents {ids} with force {force}.

GET /document/count Count documents matching a filter · Count of document #

Ask an LLM

“How many documents do we have in Workfront?”

“Can I get just a count of documents that match certain conditions?”

Tell an agent

Count all documents.

Count the documents matching {filters}.

GET /document/search Search documents with filters · Search of document #

Ask an LLM

“How do I find documents that match specific criteria?”

“Can I page and sort through document search results?”

Tell an agent

Search documents where {filters}.

Search documents matching {filters} with list options {listOptions}, returning {fields}.

GET /document/report Run an aggregate report on documents · Report of document #

Ask an LLM

“Can I get a grouped or aggregated report over our documents?”

“What's the way to build a summary report of documents meeting a condition?”

Tell an agent

Run a document report filtered by {filters}.

Build a document report for {filters} using list options {listOptions}.

PUT /document/{id}/share Share a document with a user or team · Sharing of a Document #

Ask an LLM

“How do I give a specific user or team access to one document?”

“Can I share a document but block certain actions for that person?”

Tell an agent

Share document {id} with {accessorObjCode} {accessorID} at {coreAction} access.

Give {accessorObjCode} {accessorID} {coreAction} access to document {id} but forbid {forbiddenActions}.

PUT /document/share Share several documents with one accessor · Batch sharing of a Document #

Ask an LLM

“Can I share many documents with the same user in one go?”

“How do I grant a team access to a batch of documents at once?”

Tell an agent

Share documents {ids} with {accessorObjCode} {accessorID} at {coreAction} access.

Batch-share documents {ids} to {accessorID} of type {accessorObjCode} with {coreAction}, forbidding {forbiddenActions}.

PUT /document/{id}/unshare Remove someone's access to a document · Un-sharing of a Document #

Ask an LLM

“How do I stop sharing a single document with a particular user?”

“Can I take away a team's access to one document?”

Tell an agent

Unshare document {id} from {accessorObjCode} {accessorID}.

Revoke user {accessorID} access to document {id}.

PUT /document/unshare Remove an accessor from several documents · Batch un-sharing of a Document #

Ask an LLM

“Can I remove one person's access from a whole set of documents at once?”

“Is it possible to bulk unshare documents from a team?”

Tell an agent

Unshare documents {ids} from {accessorObjCode} {accessorID}.

Batch-revoke access for {accessorID} on documents {ids}.

PUT /document/{id}/sharePublic Share a document publicly · Public share of a Document #

Ask an LLM

“How do I make one document publicly accessible?”

“Can I publicly share a document with view-only rights?”

Tell an agent

Share document {id} publicly with {coreAction} access.

Make document {id} public at {coreAction}, forbidding {forbiddenActions}.

PUT /document/sharePublic Share several documents publicly · Batch public share of a Document #

Ask an LLM

“Can I make a batch of documents public in one call?”

“What's the way to publicly share many documents at the same access level?”

Tell an agent

Publicly share documents {ids} with {coreAction} access.

Make documents {ids} public at {coreAction} but forbid {forbiddenActions}.

PUT /document/{id}/unsharePublic Stop sharing a document publicly · Public un-share of a Document #

Ask an LLM

“How do I turn off public sharing on one document?”

“Can I make a public document private again?”

Tell an agent

Remove public sharing from document {id}.

Make document {id} private again.

PUT /document/unsharePublic Stop public sharing on several documents · Batch public un-share of a Document #

Ask an LLM

“Can I turn off public links for a batch of documents at once?”

“Can I make many public documents private in one request?”

Tell an agent

Remove public sharing from documents {ids}.

Batch-unpublish the public share on documents {ids}.

PUT /document/calculateDataExtension Recalculate a document's custom data · Document calculate data extension #

Ask an LLM

“How do I recalculate the calculated custom fields on a document?”

“Can I refresh a document's custom form data extension values?”

Tell an agent

Recalculate the custom data extension for document {ID}.

Refresh calculated custom fields on document {ID}.

PUT /document/checkIn Check documents back in · Document check in #

Ask an LLM

“How do I check a document back in after editing it?”

“Can I check in several checked-out documents at once?”

Tell an agent

Check in documents {documentIDs}.

Release my checkout on document {documentIDs} by checking it in.

PUT /document/checkOut Check documents out for editing · Document check out #

Ask an LLM

“How do I check out a document so others can't edit it while I work?”

“Can I lock several documents by checking them out together?”

Tell an agent

Check out documents {documentIDs}.

Lock document {documentIDs} for my edits by checking it out.

PUT /document/completeLargeDocument Finish a large multipart document upload · Document complete large document #

Ask an LLM

“What finalizes a large file upload once all parts are sent?”

“Can I create a proof automatically when completing a large document upload?”

Tell an agent

Complete large upload {uploadID} as document {name} in folder {folderID}.

Finish upload {uploadID} with ETag map {eTagMap} and create a proof set to {createProof}.

PUT /document/createLargeDocument Start a large multipart document upload · Document create large document #

Ask an LLM

“What's the first step for uploading a very large file as a document?”

“What do I need to start a large document upload into a folder?”

Tell an agent

Start a large document upload of {fileSize} bytes into folder {folderID}.

Begin a large upload of a new version for document {documentID} sized {fileSize}.

PUT /document/createLinkedProofVersion Create a linked proof version of a document · Document create linked proof version #

Ask an LLM

“How do I add a linked proof version to an existing document?”

“Can I create a proof version from an uploaded file handle?”

Tell an agent

Create a linked proof version of document {documentID} from file handle {fileHandle}.

Add linked proof version {fileName} to document {documentID}, created by {creatorName}.

PUT /document/createProof Create a proof from a document version · Document create proof #

Ask an LLM

“How do I generate a proof for a specific document version for review?”

“Can I pass advanced proofing options like a workflow when creating a proof?”

Tell an agent

Create a proof for document version {documentVersionID}.

Create a proof for version {documentVersionID} with advanced options {advancedProofingOptions}.

PUT /document/createProofRest Create a proof via the REST proofing variant · Document create proof rest #

Ask an LLM

“Is there a REST-style call for creating a proof from a document version?”

“Which endpoint creates a proof using the createProofRest variant?”

Tell an agent

Use the REST proof variant to create a proof for version {documentVersionID}.

Call createProofRest on version {documentVersionID} with options {advancedProofingOptions}.

PUT /document/getDocumentProofTemplate Get the proof template for a proof token · Document get document proof template #

Ask an LLM

“How do I find which proof template a given proof token uses?”

“Can I look up a document's proof template from its proof token?”

Tell an agent

Get the document proof template for proof token {proofToken}.

Look up which proofing template is tied to token {proofToken}.

PUT /document/getProofRecipients List recipients for a proof template stage · Document get proof recipients #

Ask an LLM

“Who are the default recipients on a proof template's stage?”

“Can I see the reviewers configured for one stage of a proofing template?”

Tell an agent

Get proof recipients for template {templateId} stage {stageId}.

List the reviewers on stage {stageId} of proof template {templateId}.

PUT /document/getProofStages List the stages of a proof template · Document get proof stages #

Ask an LLM

“What stages does a proofing template have?”

“Can I list the review stages defined in a proof template?”

Tell an agent

Get the stages of proof template {templateId}.

Show the review stages in proofing template {templateId}.

PUT /document/getProofTemplate List available proof templates · Document get proof template #

Ask an LLM

“Which proofing templates are available to me?”

“Can I get the proof templates I can apply to new proofs?”

Tell an agent

List the proof templates available for creating proofs.

Show me every proofing workflow template I can choose from.

PUT /document/getTotalSizeForDocuments Get total file size of documents · Document get total size for documents #

Ask an LLM

“How much storage do a set of documents take up in total?”

“Can the total size include linked documents too?”

Tell an agent

Get the total size of documents {documentIDs}.

Sum the file size of documents {documentIDs} with linked documents included set to {includeLinked}.

PUT /document/isLinkedDocument Check whether a document is linked · Document is linked document #

Ask an LLM

“How can I tell if a document is linked from an external source?”

“Is a given document a linked document or an uploaded one?”

Tell an agent

Check whether document {documentID} is a linked document.

Tell me if {documentID} is linked rather than uploaded.

PUT /document/isProofAutoGenrationEnabled Check if automatic proof generation is on · Document is proof auto genration enabled #

Ask an LLM

“Is automatic proof generation enabled for our account?”

“Do uploaded documents get proofs created automatically?”

Tell an agent

Check whether proof auto-generation is enabled.

Tell me if proofs are generated automatically on upload.

PUT /document/move Move a document to another object · Document move #

Ask an LLM

“How do I move a document from one project or task to another?”

“Can I reattach a document to a different object type?”

Tell an agent

Move document {ID} to {docObjCode} {objID}.

Reattach document {ID} to object {objID}.

PUT /document/moveToFolder Move documents into a folder · Document move to folder #

Ask an LLM

“How do I move documents into a different folder?”

“Can I file several documents into one folder together?”

Tell an agent

Move documents {documentIDs} into folder {folderID}.

File {documentIDs} under document folder {folderID}.

PUT /document/sendDocumentsToExternalProvider Send documents to an external storage provider · Document send documents to external provider #

Ask an LLM

“How do I push documents out to a connected external document provider?”

“Can I choose the destination folder when sending documents to external storage?”

Tell an agent

Send documents {documentIDs} to external provider {providerID}.

Export {documentIDs} to provider {providerID} into folder {destinationFolderID}.

PUT /document/unlinkDocuments Unlink linked documents · Document unlink documents #

Ask an LLM

“Is there a way to break the link between documents and their external source?”

“Can I unlink several linked documents at once?”

Tell an agent

Unlink documents {ids}.

Remove the external link from documents {ids}.

Adobe Suite Document API

Operations 37

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification