Conga

Conga Documents API

The Documents API from Conga — 38 operation(s) for documents.

GitHub OpenAPI

Operations 51

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

POST /v1/cs-packages/{packageId}/documents Add a document to a package · Add a new document to an existing package #
Ask an LLM
“How do I upload another document to a package I already created?”
“Can I attach a new file to an existing signing transaction?”
Tell an agent
Add the file {File} as a new document in package {packageId}.
Upload a new document to package {packageId}.
DELETE /v1/cs-packages/{packageId}/documents Delete several documents from a package · Delete multiple documents from a package #
Ask an LLM
“Can I remove multiple documents from a package at once?”
“What's the way to bulk-delete documents by their IDs from a signing package?”
Tell an agent destructive · confirm first
Delete the selected documents from package {packageId} in one go.
Bulk remove documents from package {packageId}.
PUT /v1/cs-packages/{packageId}/documents Reorder or update all documents in a package · Update documents #
Ask an LLM
“Can I change the order documents appear in within a signing package?”
“How do I update several documents of a Conga Sign package in one call?”
Tell an agent
Reorder the documents in package {packageId}.
Update the document list of package {packageId} in a single request.
GET /v1/cs-packages/{packageId}/documents/all-documents/zip Download all documents including supporting docs as zip · Retrieve zipped file containing all documents including supporting documents #
Ask an LLM
“How do I download every document in a package, supporting documents included, as a zip?”
“Can I get the signable documents and the supporting attachments together in one archive?”
Tell an agent
Download a zip of all documents and supporting documents for package {packageId}.
Get the full documents archive for package {packageId} with flatten set to {flatten}.
POST /v1/cs-packages/{packageId}/documents/signConfirm Confirm a document can be signed · Create a signature confirmation #
Ask an LLM
“How do I confirm the application is allowed to run signing on a document?”
“Can I submit a signed hash to confirm a signature on a package document?”
Tell an agent
Create a signature confirmation for package {packageId}.
Confirm signing for package {packageId} using signed hash {signedHash}.
POST /v1/cs-packages/{packageId}/documents/signed_documents Sign every document in a package · Sign all documents in a package #
Ask an LLM
“Can I sign all documents in a package in a single call?”
“How do I apply a hand-drawn signature across every document in a transaction?”
Tell an agent
Sign all documents in package {packageId}.
Sign every document in package {packageId} with handdrawn signature {handdrawn}.
GET /v1/cs-packages/{packageId}/documents/visibility See which recipients can view which documents · Retrieve document visibility information #
Ask an LLM
“Which signers can see which documents during the signing ceremony?”
“How do I check document visibility settings for a package?”
Tell an agent
Show the document visibility configuration for package {packageId}.
Tell me which recipients can view each document in package {packageId}.
POST /v1/cs-packages/{packageId}/documents/visibility Set which recipients can view documents · Update document visibility #
Ask an LLM
“How do I hide a document from certain signers in a package?”
“Can I change which recipients are allowed to see each document during signing?”
Tell an agent
Update document visibility for package {packageId} with configurations {configurations}.
Restrict which signers can view documents in package {packageId}.
GET /v1/cs-packages/{packageId}/documents/zip Download the signable documents as a zip · Retrieve zipped documents #
Ask an LLM
“How do I download only the signable documents of a package as a zip?”
“Can I get a zip of the documents added to a package without the supporting files?”
Tell an agent
Download the zipped signable documents for package {packageId}.
Get the documents zip for package {packageId} with flatten {flatten}.
DELETE /v1/cs-packages/{packageId}/documents/{documentId} Delete one document from a package · Delete a document from a package #
Ask an LLM
“How do I remove a single document from a signing package?”
“Can I delete just one file from a package and keep the rest?”
Tell an agent destructive · confirm first
Delete document {documentId} from package {packageId}.
Remove only document {documentId} from package {packageId}.
GET /v1/cs-packages/{packageId}/documents/{documentId} Get a document's details · Retrieve the specified document #
Ask an LLM
“What metadata, approvals and fields does a specific document in a package have?”
“How do I look up one document's name, description and index in a package?”
Tell an agent
Get the details of document {documentId} in package {packageId}.
Show approvals and fields on document {documentId} of package {packageId}.
POST /v1/cs-packages/{packageId}/documents/{documentId} Update a document via multipart or JSON (POST) · Update a document #
Ask an LLM
“Can I update a single document by posting multipart data instead of JSON?”
“How do I change a document's description with the POST update endpoint?”
Tell an agent
Post a multipart update to document {documentId} in package {packageId}.
Set the description of document {documentId} in package {packageId} to {description} using POST.
PUT /v1/cs-packages/{packageId}/documents/{documentId} Replace a document's properties (PUT) · Update the specified document #
Ask an LLM
“Can I overwrite a document's properties with a full PUT update?”
“How do I rename a document in a package using the PUT endpoint?”
Tell an agent
Replace document {documentId} in package {packageId} via PUT, setting the name to {name}.
PUT updated properties onto document {documentId} of package {packageId}.
PUT /v1/cs-packages/{packageId}/documents/{documentId}/fields Replace a document's approvals and imprint fields · Replace approvals and imprint fields for a document #
Ask an LLM
“How do I replace all signature approvals and imprint fields on a document?”
“What happens if I send an empty approvals array when replacing document fields?”
Tell an agent
Replace approvals on document {documentId} in package {packageId} with {approvals}.
Swap the imprint fields on document {documentId} of package {packageId} for {imprintFields}.
POST /v1/cs-packages/{packageId}/documents/{documentId}/layout Apply a saved layout to a document · Apply a layout to a document #
Ask an LLM
“Can I apply a saved field layout to a document by its name?”
“How do I drop fields that fall outside the page when applying a layout?”
Tell an agent
Apply layout {layoutId} to document {documentId} in package {packageId}.
Apply the layout named {layoutName} to document {documentId} of package {packageId}.
PUT /v1/cs-packages/{packageId}/documents/{documentId}/metadata Update a document's custom metadata · Update document custom metadata #
Ask an LLM
“How do I set custom metadata on a document in a package?”
“Can I overwrite internal metadata on a document, or only custom metadata?”
Tell an agent
Overwrite the custom metadata of document {documentId} in package {packageId}.
Update custom metadata on document {documentId} of package {packageId}.
GET /v1/cs-packages/{packageId}/documents/{documentId}/original Download the original uploaded PDF · Retrieve an original PDF document #
Ask an LLM
“How do I get the original PDF as it was first added to a package, before signing?”
“Can I download the unsigned original version of a document?”
Tell an agent
Download the original PDF of document {documentId} in package {packageId}.
Fetch the pre-signing original of document {documentId} from package {packageId}.
GET /v1/cs-packages/{packageId}/documents/{documentId}/pages/{index} Get a document page as an image · Retrieve a page #
Ask an LLM
“Can I render a single page of a document as a PNG image?”
“How do I preview page 3 of a document in a package?”
Tell an agent
Get page {index} of document {documentId} in package {packageId} as a PNG.
Render page {index} of document {documentId} from package {packageId}.
GET /v1/cs-packages/{packageId}/documents/{documentId}/pdf Download a document as PDF · Retrieve a specific document in PDF form #
Ask an LLM
“How do I download one document from a package as a PDF even if it was uploaded as Word?”
“Can I always get the PDF version of a specific document?”
Tell an agent
Download document {documentId} from package {packageId} as a PDF.
Get the current PDF rendition of document {documentId} in package {packageId}.
DELETE /api/document-management/v1/documents Delete several stored documents by ID · Delete documents by their IDs #
Ask an LLM
“Can I delete a list of stored documents in one request?”
“What's the way to bulk-remove documents from document management by their IDs?”
Tell an agent destructive · confirm first
Delete this list of documents from document management.
Bulk-remove the stored documents with these IDs.
POST /api/document-management/v1/documents Upload several files to document storage · Upload documents #
Ask an LLM
“How do I upload a batch of files and attach them to a record at once?”
“Can I tag several uploaded files and mark them searchable in one request?”
Tell an agent
Upload these files {files} and attach them to {objectType} record {objectId}.
Store multiple files {files} in document management with tags {tags}.
GET /api/document-management/v1/documents/bulk Fetch several stored documents by ID · Get documents by their IDs #
Ask an LLM
“Can I retrieve many stored documents at once by passing their IDs?”
“Is there a way to skip invalid IDs when fetching documents in bulk?”
Tell an agent
Fetch stored documents {documentId} in bulk.
Get documents {documentId} and ignore invalid IDs {ignoreInvalidIds}.
POST /api/document-management/v1/documents/multipart-uploads Start a multipart upload for a large file · Initiate a multipart upload #
Ask an LLM
“How do I begin uploading a very large document in parts?”
“What upload ID and key do I need before sending file parts?”
Tell an agent
Initiate a multipart upload for document {DocumentName} on {ObjectType} {ObjectId}.
Start a large-file upload session named {DocumentName}.
GET /api/document-management/v1/documents/objects/{objectId} List a record's documents filtered by file type · Get documents by object ID and file type #
Ask an LLM
“Which PDF files are attached to a given record?”
“Can I filter a record's documents by file type using only its object ID?”
Tell an agent
List {fileType} files attached to object {objectId}.
Get documents for record {objectId} by file type.
DELETE /api/document-management/v1/documents/objects/{objectType}/{objectId} Delete all documents attached to a record · Delete documents by object type and ID #
Ask an LLM
“Can I wipe every document attached to one record?”
“How do I remove all stored files for a record by its object type and ID?”
Tell an agent destructive · confirm first
Delete all documents attached to {objectType} record {objectId}.
Remove every stored file from {objectType} {objectId}.
GET /api/document-management/v1/documents/objects/{objectType}/{objectId} List documents attached to a record · Get documents by object type and ID #
Ask an LLM
“What documents are attached to a specific agreement record?”
“How do I find all files stored against a record of a given object type?”
Tell an agent
List documents attached to {objectType} record {objectId}.
Show every stored file on {objectType} {objectId}.
GET /api/document-management/v1/documents/objects/{objectType}/{objectId}/versions List document versions for a record · Get version details by object type and ID #
Ask an LLM
“What version history exists for the documents on a record?”
“Can I see every document version stored against one agreement?”
Tell an agent
List document versions for {objectType} record {objectId}.
Show the version history of files attached to {objectType} {objectId}.
POST /api/document-management/v1/documents/search Search stored documents by criteria · Search documents using advanced query parameters #
Ask an LLM
“How can I search document management for files matching a condition?”
“Can a document search return the total count along with the results?”
Tell an agent
Search stored documents where {Criteria}.
Find documents matching {Criteria}, returning {Limit} results with a total count.
POST /api/document-management/v1/documents/upload Upload one file to document storage · Upload a single document #
Ask an LLM
“How do I upload a single Word or PDF file and attach it to a record?”
“Can I upload one file as a new version of an existing document?”
Tell an agent
Upload file {file} to {objectType} record {objectId}.
Upload {file} as new version {newVersionId} of document {documentId}.
DELETE /api/document-management/v1/documents/{documentId} Delete one stored document · Delete a document by its ID #
Ask an LLM
“Can I delete a single stored document by its ID?”
“Is there an option to permanently hard-delete a document?”
Tell an agent destructive · confirm first
Delete stored document {documentId}.
Hard-delete document {documentId} with hardDelete {hardDelete}.
PUT /api/document-management/v1/documents/{documentId} Replace a stored document's file · Update a document #
Ask an LLM
“How do I replace the file behind an existing stored document?”
“Can I update a stored document and change its description at the same time?”
Tell an agent
Replace stored document {documentId} with file {file}.
Update document {documentId} and set its description to {description}.
POST /api/document-management/v1/documents/{documentId}/clone Clone a stored document · Clone a document #
Ask an LLM
“How do I make a copy of an existing stored document?”
“Can I duplicate a document in document management?”
Tell an agent
Clone stored document {documentId}.
Make a copy of document {documentId}.
GET /api/document-management/v1/documents/{documentId}/exists Check whether a stored document exists · Check a document #
Ask an LLM
“Is there a quick way to confirm a document ID still exists?”
“Can I check that a stored document is present before downloading it?”
Tell an agent
Check whether document {documentId} exists.
Confirm stored document {documentId} is present.
GET /api/document-management/v1/documents/{documentId}/metadata Get a stored document's metadata · Get a document's metadata by its ID #
Ask an LLM
“What tags, description and checkout details does a stored document have?”
“Where can I read a document's metadata without downloading the file?”
Tell an agent
Get metadata for stored document {documentId}.
Show the tags and checkout info on document {documentId}.
PUT /api/document-management/v1/documents/{documentId}/metadata Update metadata across all document versions · Update the document metadata information for all versions #
Ask an LLM
“How do I change a document's tags or description on every version at once?”
“Can I mark a stored document as checked out by someone?”
Tell an agent
Set tags {Tags} on all versions of document {documentId}.
Mark document {documentId} checked out by {CheckoutBy}.
DELETE /api/document-management/v1/documents/{documentId}/multipart-uploads Abort an incomplete multipart upload · Abort a multipart upload #
Ask an LLM
“Can I cancel a large-file upload that never finished?”
“What gets cleaned up when a multipart upload is aborted?”
Tell an agent destructive · confirm first
Abort multipart upload {UploadId} for document {documentId}.
Cancel the unfinished large-file upload on document {documentId}.
POST /api/document-management/v1/documents/{documentId}/multipart-uploads Complete a multipart upload · Complete multipart upload #
Ask an LLM
“How do I finish a multipart upload once all parts are sent?”
“Which ETags do I pass to combine the uploaded parts into one file?”
Tell an agent
Complete multipart upload {UploadId} for document {documentId} with ETags {ETags}.
Combine the uploaded parts of document {documentId} into the final file.
PUT /api/document-management/v1/documents/{documentId}/multipart-uploads Upload one part of a multipart upload · Upload a single part of a large file #
Ask an LLM
“How do I send each chunk of a large file during a multipart upload?”
“What part number and ETag come back for each uploaded file part?”
Tell an agent
Upload part {partNumber} of document {documentId} for upload {uploadId}.
Send chunk {partNumber} using key {key} for large-file document {documentId}.
GET /api/document-management/v1/documents/{documentId}/versions List a stored document's versions · Retrieve document versions #
Ask an LLM
“How many versions does a particular stored document have?”
“Can I see the version list for one document ID?”
Tell an agent
List versions of stored document {documentId}.
Show the version history for document {documentId}.
DELETE /api/document-management/v1/documents/{documentId}/versions/{versionId} Delete one version of a stored document · Delete a versioned document #
Ask an LLM
“Can I remove a single version of a document but keep the others?”
“How do I delete an unwanted document version?”
Tell an agent destructive · confirm first
Delete version {versionId} of document {documentId}.
Remove only version {versionId} from stored document {documentId}.
GET /api/document-management/v1/documents/{documentId}/versions/{versionId} Get a specific version of a stored document · Get a document by its ID and version #
Ask an LLM
“How do I retrieve an older version of a stored document?”
“Can I fetch one exact version of a document by version ID?”
Tell an agent
Get version {versionId} of document {documentId}.
Retrieve document {documentId} as it was at version {versionId}.
GET /api/document-management/v1/documents/{id} Get document info by version ID · Get document information by its ID #
Ask an LLM
“Can I look up a document's metadata when I only have its version ID?”
“What information comes back for a document version ID?”
Tell an agent
Get document information for version ID {id}.
Look up the document behind version {id}.
GET /api/document-management/v1/documents/{id}/download Download a stored document file · Get a document by its ID #
Ask an LLM
“How do I download the actual file content of a stored document?”
“Can I download a document using its version ID?”
Tell an agent
Download the file for document version {id}.
Save a copy of stored document {id} locally.
POST /v2/documents/convert Convert a batch of documents to another format · Convert documents' format #
Ask an LLM
“How do I convert a batch of Word documents to PDF in one request?”
“Can converted documents be delivered to more than one destination?”
Tell an agent
Convert these documents to PDF using request {request}.
Run a batch format conversion with request {request}.
POST /v2/documents/generate Generate a document from templates and data · Generate a document from merge templates and data sources #
Ask an LLM
“How do I merge a template with data from several sources to generate a PDF?”
“Can I generate a document by merging an XAuthor template with platform data?”
Tell an agent
Generate a document from merge templates using request {request}.
Merge templates with data sources and produce the output described in {request}.
POST /v2/documents/join Join documents into a single file · Join documents from multiple sources #
Ask an LLM
“Can I combine Word documents from different sources into a single document?”
“How do I join several documents and deliver the merged result?”
Tell an agent
Join the documents described in {request} into one file.
Combine documents from multiple sources using join request {request}.
POST /v2/documents/process Run a multi-step document processing request · Documents process #
Ask an LLM
“Is there a general endpoint to process a batch of documents in one request?”
“Can I submit a document processing job that isn't tied to one document ID?”
Tell an agent
Submit document processing request {request} for multiple documents.
Process documents in bulk with request {request}.
POST /v2/documents/protect Apply or remove protection on several documents · Change document protection #
Ask an LLM
“How do I add edit restrictions to a batch of documents?”
“Can I remove protection from documents fetched from multiple sources?”
Tell an agent
Apply protection to the documents in request {request}.
Remove protection from a batch of documents using {request}.
POST /v2/documents/{documentId}/convert Convert one document to another format · Convert a document's format #
Ask an LLM
“How do I convert a single stored document to PDF by its ID?”
“Can I convert just one document and send the result to a destination?”
Tell an agent
Convert document {documentId} to PDF.
Convert document {documentId} using conversion request {request}.
POST /v2/documents/{documentId}/process Process a single document by ID · Documents process2 #
Ask an LLM
“Can I run processing steps on one specific document by its ID?”
“What's the call for processing a single document rather than a batch?”
Tell an agent
Process document {documentId}.
Run processing request {request} on document {documentId}.
POST /v2/documents/{documentId}/protect Apply or remove protection on one document · Change document protection #
Ask an LLM
“How do I apply edit restrictions to one Word document by its ID?”
“Can I unprotect a single document and deliver it somewhere?”
Tell an agent
Protect document {documentId} against editing.
Change protection on document {documentId} using request {request}.

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/authentication/conga-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/rate-limits/conga-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-documents-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/data-model/conga-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/scopes/conga-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conventions/conga-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/errors/conga-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/lifecycle/conga-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conformance/conga-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/sandbox/conga-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/asyncapi/conga-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/conga:conga-documents-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

conga-documents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Conga Documents API
  version: '1.0'
  description: 'Operations tagged Documents across 3 of this provider''s published API definitions: conga-conga-sign.json, conga-document-management.json, conga-ingress.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://rls.congacloud.com/api/sign
- url: https://rls.congacloud.com
- url: https://rls.congacloud.com/api/ingress
tags:


# --- truncated at 32 KB (184 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-documents-api-openapi.yml