Docugami logo
API docs by Redocly

Docugami REST API (v1preview1)

Download OpenAPI specification:

Docugami: contact@docugami.com URL: https://www.docugami.com/contact-us Terms of Service

documents

Upload, download, delete, and view details of documents.

List documents

Authorizations:
clientapi-key
query Parameters
name
string

Filters documents by name, excluding any prefix.

limit
integer <int32> [ 1 .. 100 ]
Default: 30

Maximum number of items to return.

cursor
string

Opaque continuation token used to get additional items when a previous query returned more than limit items.

docset.id
string

Filters documents by docset.

status
string (document-status)
Enum: "New" "Ingesting" "Ingested" "Processing" "Ready" "Error" "OverQuota"
Example: status=Ready

Filters documents by status.

prefix
string

Filters documents by name beginning with this prefix.

minPages
integer <int32> >= 0

Filters documents by minimum number of pages in the document.

maxPages
integer <int32> >= 0

Filters documents by maximum number of pages in the document.

minSize
integer <int32> >= 0

Filters documents by minimum file size in bytes.

maxSize
integer <int32> >= 0

Filters documents by maximum file size in bytes.

samples
boolean
Default: false

Whether or not to return sample documents.

metadata.{key}
string^metadata\.\w{1,100}$

Filters documents by metadata value (e.g. metadata.version=1.0.0). An empty value will filter for the existence of the key regardless of value.

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/documents

Response samples

Content type
application/json
{}

Get a document

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/documents/ID

Response samples

Content type
application/json
{}

Delete a document

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --request DELETE \
  https://api.docugami.com/v1preview1/documents/ID

Upload a document

The maximum request size is 300 MB. The allowed file extensions are: .pdf, .docx, .doc, .txt, .html, and .zip. For zip archive uploads, only files with .pdf, .docx, .txt, .html, or .doc extensions within the archive will be processed. file must be the final form part.

Authorizations:
clientapi-key
Request Body schema: multipart/form-data
docset.id
string
object (document-metadata-request)
file
required
string <binary>

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --form docset.id=ID \
  --form metadata='{"metadata": [{"key": "my key", "value": "my value"}]}' \
  --form file=@document.pdf \
  https://api.docugami.com/v1preview1/documents/content

Response samples

Content type
application/json
{}

Get download headers

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --head \
  --request HEAD \
  https://api.docugami.com/v1preview1/documents/ID/content

Download a document

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --header "Accept: application/octet-stream" \
  --remote-name \
  --remote-header-name \
  https://api.docugami.com/v1preview1/documents/ID/content

Gets the info for a specific page of a document

Authorizations:
clientapi-key
path Parameters
id
required
string
pageNumber
required
integer

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/documents/ID/pages/PAGE-NUMBER

Response samples

Content type
application/json
{}

List the pages of a document

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/documents/ID/pages/PAGE-NUMBER

Response samples

Content type
application/json
{}

Get download headers for a document page image

Authorizations:
clientapi-key
path Parameters
id
required
string
pageNumber
required
integer

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --head \
  --request HEAD \
  https://api.docugami.com/v1preview1/documents/ID/pages/PAGE-NUMBER/content

Download a document page image

Authorizations:
clientapi-key
path Parameters
id
required
string
pageNumber
required
integer

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --header "Accept: application/octet-stream" \
  --remote-name \
  --remote-header-name \
  https://api.docugami.com/v1preview1/documents/ID/pages/PAGE-NUMBER/content

Get document metadata

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/documents/ID/metadata

Response samples

Content type
application/json
{}

Set document metadata

Authorizations:
clientapi-key
path Parameters
id
required
string
Request Body schema: application/json
required
Array of objects (document-metadata-array) <= 10 properties

A collection of key-value pairs associated with a document.

Responses

Request samples

Content type
application/json
{
  • "metadata": [
    ]
}

Response samples

Content type
application/json
{}

Delete document metadata

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --request DELETE \
  https://api.docugami.com/v1preview1/documents/ID/metadata

Update document metadata

Authorizations:
clientapi-key
path Parameters
id
required
string
Request Body schema: application/json
required
Array of objects (document-metadata-array) <= 10 properties

A collection of key-value pairs associated with a document.

Responses

Request samples

Content type
application/json
{
  • "metadata": [
    ]
}

Response samples

Content type
application/json
{}

Initialize a new upload session

Creates an upload session for a large file. The client will use the returned sessionId to upload chunks and finalize the upload.

Authorizations:
clientapi-key
Request Body schema: multipart/form-data
docset.id
string
object (document-metadata-request)
fileName
required
string
fileSize
required
integer <int64>

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --form docset.id=ID \
  --form metadata='{"metadata": [{"key": "my key", "value": "my value"}]}' \
  --form fileName=document.pdf \
  --form fileSize=104857600 \
  https://api.docugami.com/v1preview1/documents/uploads/session

Response samples

Content type
application/json
{}

Upload a chunk to an existing session

Uploads a chunk of the file to the session. Chunks can be uploaded in any order, as long as the correct byteOffset is provided for each chunk.

Validation Rules:

  • byteOffset must align to the configured chunkSize (i.e., byteOffset % chunkSize == 0).
  • byteOffset must be within the range 0 <= byteOffset < fileSize.
  • For non-final chunks, the uploaded chunk size must equal chunkSize.
  • For the last chunk, the size must exactly match fileSize - byteOffset.
  • If these conditions are not met, the request will return 400 Bad Request with an appropriate error message.
Authorizations:
clientapi-key
path Parameters
sessionId
required
string
Request Body schema: multipart/form-data
byteOffset
required
integer <int64>
file
required
string <binary>

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --form byteOffset=0 \
  --form file=@chunk1.bin \
  https://api.docugami.com/v1preview1/documents/uploads/session/abc123/chunk

Response samples

Content type
application/json
{
  • "sessionId": "abc123",
  • "blockId": "MjVhMTQz",
  • "status": "in-progress"
}

Finalize the upload session

Completes the upload process and assembles the chunks into the final document. Once finalized, the file is ingested by Docugami for processing and classification into the appropriate docset(s).

Authorizations:
clientapi-key
path Parameters
sessionId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  -X POST \
  https://api.docugami.com/v1preview1/documents/uploads/session/abc123/finalize

Response samples

Content type
application/json
{}

Create a temporary upload URL

Creates a short-lived URL that can be used to upload a single document without authentication. The URL embeds the target docset, metadata, and filename so the upload endpoint requires no additional parameters.

  • fileName is required and must match exactly when uploading via the returned URL.
  • docset.id accepts a single docset ID (direct assignment) or a |-delimited list of IDs (classification).
  • timeToLive defaults to 600 seconds (10 minutes); valid range is 60–14400 seconds.
  • The URL may only be used once. After a successful upload it transitions to Consumed state.
Authorizations:
clientapi-key
Request Body schema: application/json
required
fileName
required
string

Name of the file that will be uploaded. Must match the filename sent during upload.

docset.id
string

Optional. A single docset ID assigns the document to that docset directly. A |-delimited list of IDs classifies the document into the best-matching docset.

metadata
string

Optional JSON-serialized metadata object (same shape as document-metadata-request).

timeToLive
integer

Seconds until the URL expires. Minimum 60, maximum 14400. Defaults to 600.

Responses

Request samples

Content type
application/json
{
  • "fileName": "contract.pdf",
  • "docset.id": "abc123",
  • "metadata": "{\"metadata\": [{\"key\": \"version\", \"value\": \"1.0\"}]}",
  • "timeToLive": 600
}

Response samples

Content type
application/json
{}

Get temporary URL status

Returns the current state of a temporary upload URL.

Authorizations:
clientapi-key
path Parameters
temporaryUrlId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/documents/temporaryUrl/ID

Response samples

Content type
application/json
{
  • "fileName": "contract.pdf",
  • "expiresAt": "2025-11-14T10:22:43",
  • "state": "Created"
}

Delete a temporary URL

Revokes a temporary upload URL before it is used or expires.

Authorizations:
clientapi-key
path Parameters
temporaryUrlId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --request DELETE \
  https://api.docugami.com/v1preview1/documents/temporaryUrl/ID

Upload a document via temporary URL

Uploads a document using a temporary URL created by POST /documents/temporaryUrl. No authentication is required.

  • The fileName in the multipart body must exactly match the filename set when the temporary URL was created.
  • For zip archive uploads, only files with .pdf, .docx, .txt, .html, or .doc extensions within the archive will be processed.
  • The URL may only be used once. After a successful upload it transitions to Consumed state.
  • file must be the only and final form part — docset and metadata were captured when the URL was created.
  • Maximum request size is 300 MB.
path Parameters
temporaryUrlId
required
string
Request Body schema: multipart/form-data
file
required
string <binary>

Binary file. Must be a .pdf, .docx, .doc, .html, .txt, or .zip. Must be the only form part.

Responses

Request samples 

curl --form file=@contract.pdf \
  https://api.docugami.com/v1preview1/documents/temporaryUrl/ID/content

Response samples

Content type
application/json
{}

Initialize a chunked upload session via temporary URL

Creates a chunked upload session for a large file using a temporary URL. No authentication is required.

The file extension must be .pdf, .docx, or .doc; zip, text, and HTML files are not supported for chunked uploads. Use the returned uploadUrl and finalizeUrl to upload chunks and complete the upload.

path Parameters
temporaryUrlId
required
string
Request Body schema: multipart/form-data
fileSize
required
integer <int64>

Total size of the file in bytes.

Responses

Request samples 

curl --form fileSize=104857600 \
  https://api.docugami.com/v1preview1/documents/temporaryUrl/ID/uploads/session

Response samples

Content type
application/json
{}

Upload a chunk via temporary URL

Uploads a chunk of the file to an existing session. No authentication is required.

Chunks can be uploaded in any order as long as the correct byteOffset is provided.

Validation Rules:

  • byteOffset must align to the configured chunkSize (i.e., byteOffset % chunkSize == 0).
  • byteOffset must be within the range 0 <= byteOffset < fileSize.
  • For non-final chunks, the uploaded chunk size must equal chunkSize.
  • For the last chunk, the size must exactly match fileSize - byteOffset.
path Parameters
temporaryUrlId
required
string
sessionId
required
string
Request Body schema: multipart/form-data
byteOffset
required
integer <int64>

Byte offset where this chunk starts.

file
required
string <binary>

Chunk of the file.

Responses

Request samples 

curl --request PUT \
  --form byteOffset=0 \
  --form file=@chunk1.bin \
  https://api.docugami.com/v1preview1/documents/temporaryUrl/ID/uploads/session/abc123/chunk

Response samples

Content type
application/json
{
  • "sessionId": "abc123",
  • "blockId": "MjVhMTQz",
  • "status": "in-progress"
}

Finalize a chunked upload via temporary URL

Completes the upload and assembles the chunks into the final document. No authentication is required.

Once finalized, the file is ingested by Docugami for processing and classification into the appropriate docset(s). The temporary URL transitions to Consumed state on success.

path Parameters
temporaryUrlId
required
string
sessionId
required
string

Responses

Request samples 

curl --request POST \
  https://api.docugami.com/v1preview1/documents/temporaryUrl/ID/uploads/session/abc123/finalize

Response samples

Content type
application/json
{}

docsets

Associate documents into sets.

List docsets

Authorizations:
clientapi-key
query Parameters
name
string

Filters docsets by name.

limit
integer <int32> [ 1 .. 100 ]
Default: 30

Maximum number of items to return.

cursor
string

Opaque continuation token used to get additional items when a previous query returned more than limit items.

minDocuments
integer <int32>

Filters docsets by minimum number of documents in the set.

maxDocuments
integer <int32>

Filters docsets by maximum number of documents in the set.

samples
boolean
Default: false

Whether or not to return sample docsets.

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/docsets

Response samples

Content type
application/json
{}

Create a docset

Authorizations:
clientapi-key
Request Body schema: application/json
name
required
string

The name of the docset.

documents
Array of strings

Optional collection of document ids to include in the new docset. Documents will be moved if they already belong to a docset.

Responses

Request samples

Content type
application/json
{
  • "name": "Loss Runs",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{}

Get a docset

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/docsets/ID

Response samples

Content type
application/json
{}

Delete a docset

Deleting a docset does not delete any documents it contains.

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --request DELETE \
  https://api.docugami.com/v1preview1/docsets/ID

List documents in a docset

Authorizations:
clientapi-key
path Parameters
id
required
string
query Parameters
prefix
string

Filters documents by name beginning with this prefix.

limit
integer <int32> [ 1 .. 100 ]
Default: 30

Maximum number of items to return.

cursor
string

Opaque continuation token used to get additional items when a previous query returned more than limit items.

status
string (document-status)
Enum: "New" "Ingesting" "Ingested" "Processing" "Ready" "Error" "OverQuota"
Example: status=Ready

Filters documents by status.

minPages
integer <int32> >= 0

Filters documents by minimum number of pages in the document.

maxPages
integer <int32> >= 0

Filters documents by maximum number of pages in the document.

minSize
integer <int32> >= 0

Filters documents by minimum file size in bytes.

maxSize
integer <int32> >= 0

Filters documents by maximum file size in bytes.

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/docsets/ID/documents

Response samples

Content type
application/json
{}

Add a document to a docset

The document is moved if it is already part of a docset.

Authorizations:
clientapi-key
path Parameters
docsetId
required
string
documentId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --method PUT \
  https://api.docugami.com/v1preview1/docsets/DOCSET-ID/documents/DOCUMENT-ID

Response samples

Content type
application/json
{}

Get a document from a docset

Authorizations:
clientapi-key
path Parameters
docsetId
required
string
documentId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/docsets/DOCSET-ID/documents/DOCUMENT-ID

Response samples

Content type
application/json
{}

Remove a document from a docset

Removing a document from a docset does not delete the document.

Authorizations:
clientapi-key
path Parameters
docsetId
required
string
documentId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --method DELETE \
  https://api.docugami.com/v1preview1/docsets/DOCSET-ID/documents/DOCUMENT-ID

Download processed document output

Authorizations:
clientapi-key
path Parameters
docsetId
required
string
documentId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --header "Accept: application/xml" \
  --remote-name \
  --remote-header-name \
  https://api.docugami.com/v1preview1/docsets/DOCSET-ID/documents/DOCUMENT-ID/dgml

List docset properties

Authorizations:
clientapi-key
path Parameters
docsetId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/docsets/DOCSET-ID/properties

Response samples

Content type
application/json
{}

Create a docset property

Authorizations:
clientapi-key
path Parameters
docsetId
required
string
Request Body schema: application/json
label
required
string

Labels must conform to XML 1.0 rev 4 naming conventions. Exceptions include leading digits and spaces.

Responses

Request samples

Content type
application/json
{
  • "label": "my label"
}

Response samples

Content type
application/json
{}

Get a docset property

Authorizations:
clientapi-key
path Parameters
docsetId
required
string
propertyId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/docsets/DOCSET-ID/properties/ID

Response samples

Content type
application/json
{}

Update a docset property

Authorizations:
clientapi-key
path Parameters
docsetId
required
string
propertyId
required
string
Request Body schema: application/json
label
required
string

Labels must conform to XML 1.0 rev 4 naming conventions. Exceptions include leading digits and spaces.

Responses

Request samples

Content type
application/json
{
  • "label": "new label"
}

Response samples

Content type
application/json
{}

Delete a docset property

Authorizations:
clientapi-key
path Parameters
docsetId
required
string
propertyId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --method DELETE \
  https://api.docugami.com/v1preview1/docsets/DOCSET-ID/properties/ID

List document properties

Authorizations:
clientapi-key
path Parameters
docsetId
required
string
documentId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/docsets/DOCSET-ID/document-properties/DOCUMENT-ID

Response samples

Content type
application/json
{}

Create a document property

Authorizations:
clientapi-key
path Parameters
docsetId
required
string
documentId
required
string
Request Body schema: application/json
label
required
string

Labels must conform to XML 1.0 rev 4 naming conventions. Exceptions include leading digits and spaces.

value
required
string

The value of the property.

Responses

Request samples

Content type
application/json
{
  • "label": "my label",
  • "value": "my value"
}

Response samples

Content type
application/json
{}

Get a document property value

Authorizations:
clientapi-key
path Parameters
docsetId
required
string
propertyId
required
string
documentId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/docsets/DOCSET-ID/properties/PROPERTY-ID/documents/DOCUMENT-ID

Response samples

Content type
application/json
{}

Set a document property value

Authorizations:
clientapi-key
path Parameters
docsetId
required
string
propertyId
required
string
documentId
required
string
Request Body schema: application/json
value
required
string

The value of the property.

Responses

Request samples

Content type
application/json
{
  • "value": "new value"
}

Response samples

Content type
application/json
{}

projects

Manage projects and associated artifacts.

List projects

Authorizations:
clientapi-key
query Parameters
name
string

Filters projects by name.

limit
integer <int32> [ 1 .. 100 ]
Default: 30

Maximum number of items to return.

cursor
string

Opaque continuation token used to get additional items when a previous query returned more than limit items.

docset.id
string

Filters projects by docset.

type
string (project-type)
Enum: "TabularReport" "Abstract" "ExcelExport" "AssistedAuthoring" "AutomationAnywhereDocumentAssembly" "AutomationAnywhereWorkFlow" "ZapierWorkFlow" "UiPathWorkFlow" "UiPathDocumentAssembly" "PowerAutomateWorkFlow" "DiligenceReport"
Example: type=TabularReport

Filters projects by type.

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/projects

Response samples

Content type
application/json
{}

Create a project

Authorizations:
clientapi-key
Request Body schema: application/json
name
required
string

The name of the project.

type
required
any (project-type)
Enum: "TabularReport" "Abstract" "ExcelExport" "AssistedAuthoring" "AutomationAnywhereDocumentAssembly" "AutomationAnywhereWorkFlow" "ZapierWorkFlow" "UiPathWorkFlow" "UiPathDocumentAssembly" "PowerAutomateWorkFlow" "DiligenceReport"
docset.id
required
string

The ID of the docset this project will be associated with.

Array of objects (project-item)
autoConfirmDocuments
boolean

Whether or not incoming documents will be auto confirmed for a published project.

Responses

Request samples

Content type
application/json
{
  • "name": "Loss Runs",
  • "type": "TabularReport",
  • "docset.id": "string",
  • "items": [
    ],
  • "autoConfirmDocuments": true
}

Response samples

Content type
application/json
{}

Get a project

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/projects/ID

Response samples

Content type
application/json
{}

Delete a project

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --request DELETE \
  https://api.docugami.com/v1preview1/projects/ID

Publish a project

Authorizations:
clientapi-key
path Parameters
id
required
string
Request Body schema: application/json
optional
autoConfirmDocuments
boolean

Whether or not incoming documents will be auto confirmed for a published project.

Responses

Request samples

Content type
application/json
{
  • "autoConfirmDocuments": true
}

Response samples

Content type
application/problem+json
{}

Update published project settings

Authorizations:
clientapi-key
path Parameters
id
required
string
Request Body schema: application/json
required
autoConfirmDocuments
required
boolean

Whether or not incoming documents will be auto confirmed for a published project.

Responses

Request samples

Content type
application/json
{
  • "autoConfirmDocuments": true
}

Response samples

Content type
application/problem+json
{}

Unpublish a project

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Response samples

Content type
application/problem+json
{}

List artifacts

Authorizations:
clientapi-key
path Parameters
projectId
required
string
version
string
Examples: 1 2 latest
query Parameters
name
string

Filters artifacts by name.

document.id
string

Filters artifacts by document id.

limit
integer <int32> [ 1 .. 100 ]
Default: 30

Maximum number of items to return.

cursor
string

Opaque continuation token used to get additional items when a previous query returned more than limit items.

minSize
integer <int32>

Filters artifacts by minimum file size in bytes.

maxSize
integer <int32>

Filters artifacts by maximum file size in bytes

isReadOnly
boolean

Filters artifacts by read-only status.

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/projects/ID/artifacts

Response samples

Content type
application/json
{}

Get an artifact

Authorizations:
clientapi-key
path Parameters
projectId
required
string
version
required
string
Examples: 1 2 latest
artifactId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/projects/PROJECT-ID/artifacts/latest/ARTIFACT-ID

Response samples

Content type
application/json
{}

Delete an artifact

Read-only artifacts cannot be deleted.

Authorizations:
clientapi-key
path Parameters
projectId
required
string
version
required
string
Examples: 1 2 latest
artifactId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --request DELETE \
  https://api.docugami.com/v1preview1/projects/PROJECT-ID/artifacts/latest/ARTIFACT-ID

Response samples

Content type
application/problem+json
{}

Get artifact download headers

Authorizations:
clientapi-key
path Parameters
projectId
required
string
version
required
string
Examples: 1 2 latest
artifactId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --head \
  --request HEAD \
  https://api.docugami.com/v1preview1/projects/PROJECT-ID/artifacts/latest/ARTIFACT-ID/content

Downloads an artifact

Authorizations:
clientapi-key
path Parameters
projectId
required
string
version
required
string
Examples: 1 2 latest
artifactId
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --header "Accept: application/octet-stream" \
  --remote-name \
  --remote-header-name \
  https://api.docugami.com/v1preview1/projects/PROJECT-ID/artifacts/latest/ARTIFACT-ID/content

Upload an artifact

The maximum request size is 300 MB. The allowed file extensions are: .xml, .json, .csv, .xlsx, .pdf, and .docx.

Authorizations:
clientapi-key
path Parameters
projectId
required
string
version
required
string
Examples: 1 2 latest
Request Body schema: multipart/form-data
document.id
string
file
required
string <binary>

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --form document.id=DOCUMENT-ID \
  --form file=@artifact.xml \
  https://api.docugami.com/v1preview1/projects/PROJECT-ID/artifacts/1/content

Response samples

Content type
application/json
{}

sample-catalog

View all available samples.

List sample catalog

Authorizations:
clientapi-key
query Parameters
name
string

Filters sample catalog by name.

limit
integer <int32> [ 1 .. 100 ]
Default: 30

Maximum number of items to return.

cursor
string

Opaque continuation token used to get additional items when a previous query returned more than limit items.

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/sample-catalog

Response samples

Content type
application/json
{
  • "samples": [
    ],
  • "next": "https://api.docugami.com/v1preview1/sample-catalog?cursor=%5B%7B%22token%22%3A%22&limit=3"
}

Get a sample catalog item

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/sample-catalog/ID

Response samples

Content type
application/json
{
  • "id": "xmtqwbg4g0i8",
  • "name": "Service Agreements",
  • "description": "Software Related Master Services Agreements that establish the legal and operational parameters for engaging in software-related services. These agreements encompass the delineation of project scope, service-level expectations, intellectual property ownership, confidentiality obligations, and the protocol for resolving disputes.",
  • "version": "3",
  • "createdAt": "2023-03-13T20:22:30.6981643+00:00",
  • "updatedAt": "2023-03-13T20:22:31.0982176+00:00"
}

samples

Install, remove, and view samples in the workspace.

List samples

Authorizations:
clientapi-key
query Parameters
name
string

Filters samples by name.

status
string (sample-status)
Enum: "Ready" "InProgress" "Error"
Example: status=Ready

Filters samples by status

limit
integer <int32> [ 1 .. 100 ]
Default: 30

Maximum number of items to return.

cursor
string

Opaque continuation token used to get additional items when a previous query returned more than limit items.

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/samples

Response samples

Content type
application/json
{
  • "samples": [
    ],
  • "next": "https://api.docugami.com/v1preview1/samples?cursor=%5B%7B%22token%22%3A%22&limit=3"
}

Install a sample

Authorizations:
clientapi-key
Request Body schema: application/json
id
required
string

The id of the sample catalog item.

Responses

Request samples

Content type
application/json
{
  • "id": "xmtqwbg4g0i8"
}

Response samples

Content type
application/json
{
  • "samples": [
    ],
  • "next": "https://api.docugami.com/v1preview1/samples?cursor=%5B%7B%22token%22%3A%22&limit=3"
}

Get a sample

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/samples/ID

Response samples

Content type
application/json
{
  • "id": "gmk07l49tk2c",
  • "catalog": {},
  • "name": "Service Agreements",
  • "description": "Software Related Master Services Agreements that establish the legal and operational parameters for engaging in software-related services. These agreements encompass the delineation of project scope, service-level expectations, intellectual property ownership, confidentiality obligations, and the protocol for resolving disputes.",
  • "version": "3",
  • "status": "Ready",
  • "createdAt": "2023-03-13T20:22:30.6981643+00:00",
  • "updatedAt": "2023-03-13T20:22:31.0982176+00:00"
}

workspace

View workspace status.

Get workspace details

Authorizations:
clientapi-key

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/workspace

Response samples

Content type
application/json
{
  • "id": "qgwjgy7tq0ui",
  • "name": "Example Workspace",
  • "createdAt": "2023-03-06T16:59:52.3057791+00:00",
  • "type": "Trial",
  • "expired": true,
  • "expiresAt": "2023-03-21T16:59:51.3057791+00:00",
  • "quota": {
    }
}

webhooks

Create and manage webhooks.

List webhooks

Authorizations:
clientapi-key
query Parameters
target
any (Webhook target)
Enum: "Documents" "Project" "Docset"
Example: target=Project

Filters webhooks by target type. 'read:documents' scope is required for document and docset targets and 'read:projects' for project targets.

targetId
string
Example: targetId=0gjiwhvpeqcg

Filters webhooks by target id.

limit
integer <int32> [ 1 .. 100 ]
Default: 30

Maximum number of items to return.

cursor
string

Opaque continuation token used to get additional items when a previous query returned more than limit items.

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/webhooks

Response samples

Content type
application/json
{}

Create a webhook

Authorizations:
clientapi-key
Request Body schema: application/json
target
required
any (webhook-target)
Enum: "Documents" "Project" "Docset"
url
required
string <uri>
targetId
string
events
Array of any (Webhook events)
Items Enum: "Documents.Create" "Documents.Delete" "Docset.Document.Add" "Docset.Document.Remove" "Docset.Document.Dgml" "Project.Artifacts.Create" "Project.Artifacts.Delete" "Project.Artifacts.Modify" "Project.Artifacts.Version"
secret
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Get a webhook

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  https://api.docugami.com/v1preview1/webhooks/ID

Response samples

Content type
application/json
{}

Delete a webhook

Authorizations:
clientapi-key
path Parameters
id
required
string

Responses

Request samples 

curl --header "Authorization: Bearer <API-KEY>" \
  --request DELETE \
  https://api.docugami.com/v1preview1/webhooks/ID

Response samples

Content type
application/problem+json
{}