Documents

Models

Document Model

The document model represents a file stored in Google Cloud Storage and its associated metadata.

object "document"
The enum value identifying this as a document model.

id string
Unique identifier for this document, prefixed with dcmt_.

file object
The file name, access URL, and file metadata for the document.

Show Details


Object.name `string` Human-readable label for the document. Between 3 and 128 characters. Defaults to `filename` if not provided at creation.
Object.url `string` The URL to access the file. For public documents, a permanent CDN URL. For private documents, the raw GCS URL by default - use `?include_document_url=true` on retrieve to get a 15-minute signed URL.
Object.checksum `string` \| `null` Client-provided checksum for integrity verification. `null` if not provided at creation.
Object.size `string` \| `null` The size of the file as a byte count string (e.g. `"204800"`). In sync uploads, computed from the decoded buffer. In async uploads, populated from GCS object metadata after verification. `null` until an async upload is verified.
Object.mime_type `string` \| `null` The MIME type of the file (e.g. `application/pdf`, `image/jpeg`). In sync uploads, extracted from the data-URI prefix. In async uploads, provided at creation and confirmed from GCS metadata after verification. `null` until an async upload is verified.

checksum_md5 string | null
Client-provided Base64-encoded MD5 checksum for integrity verification.

checksum_sha256 string | null
Client-provided hex-encoded SHA-256 checksum.

visibility string
Access control for the file. "public" means the file is world-readable via a permanent CDN URL. "private" means access requires a signed URL. Immutable after creation.

upload_status string
The upload state of the document (DocumentStatus enum). Can be requested, completed, failed, or expired. See Upload Modes for the state machine.

category string
The document category. One of: photo, invoice, spec_sheet, contract, certificate, warranty, manual, shipping, other.

metadata object
Arbitrary key/value pairs associated with the document.

created_by string
The ID of the user or API key that created this document.

created_by_details object
Display details for the creator.

Show Details


Object.id `string` The ID of the user or API key.
Object.name `string` The display name of the user or API key.

linkages object
A count of active links per resource type. Always present. Keys are singular resource type names: asset, shipment, item, manifest, fulfillment. Example: { "shipment": 2, "asset": 1, "item": 0, "manifest": 0, "fulfillment": 0 }.

_upload_url string | null
The signed GCS PUT URL for async uploads. Returned on create when no content field is provided. null for sync uploads and on all subsequent responses. Use this URL to PUT the file bytes directly to GCS (no API key needed).

created_at string
ISO date string when this document was created.

updated_at string
ISO date string when this document was last updated.

deleted_at string | null
ISO date string when this document was soft-deleted. null for active documents.

checksum string
A server-computed HMAC of the document object. Use to detect response tampering or to check whether a document has changed since last retrieved.

Document Link Entry

A document link represents an association between a document and a platform resource.

id string
Unique identifier for this link. A raw v7 UUID (e.g. 019696c6-4b3a-7e1d-b9a2-3f8c1d0e5a72).

resource object
The resource this document is linked to.

Show Details


Object.id `string` The ID of the resource.
Object.type `string` The resource type: `asset`, `shipment`, `manifest`, `fulfillment`, or `item`.

created_at integer
Time in epoch seconds when this link was created.

Models

# Document Model

# Document Link Entry

On this page

Document Model

Document Link Entry