Artifact Ingestion
Artifacts are the documents you distribute through Docyard. This guide covers all ingestion methods, deduplication behavior, and metadata strategies.
Single File Upload
The most straightforward method — upload one file at a time:
curl -X POST https://api.docyard.io/v1/docks/dock_01HQ3K.../artifacts/upload \
-H "Authorization: Bearer dk_live_a1b2c3d4..." \
-F "[email protected]"
Batch Upload
Upload up to 100 files in a single request:
Each file is independently hashed and deduplicated. The response includes a batchId for tracking and an array of artifact results.
For volumes exceeding 100 files per request, split into multiple batch calls. The Go-based batch assembler handles background processing for large-scale ingestion.
curl -X POST https://api.docyard.io/v1/docks/dock_01HQ3K.../artifacts \
-H "Authorization: Bearer dk_live_a1b2c3d4..." \
-H "Content-Type: application/json" \
-d '{
"filename": "policy-renewal-2025.pdf",
"metadata": {
"policy_number": "POL-2025-4821",
"effective_date": "2025-01-01",
"document_type": "renewal",
"source_system": "legacy-dms"
}
}'
curl -X POST https://api.docyard.io/v1/docks/dock_01HQ3K.../artifacts/batch \
-H "Authorization: Bearer dk_live_a1b2c3d4..." \
-H "Content-Type: application/json" \
-d '{
"items": [
{ "filename": "dec-001.pdf", "metadata": { "policy_number": "POL-001" } },
{ "filename": "dec-002.pdf", "metadata": { "policy_number": "POL-002" } }
]
}'
Deduplication
Docyard uses content-addressable storage. When you upload a file:
- SHA-256 hash is computed from the file content
- If the hash matches an existing artifact in the dock, the upload succeeds but no new storage is consumed
- The response includes
isDuplicate: true and returns the existing artifact’s ID
This means:
- Re-uploading after a failed batch costs nothing
- The same file uploaded from different sources is stored once
- You pay for unique content, not upload volume
Artifact metadata powers policy routing and filtering. Design your metadata schema around your business operations:
Insurance
Real Estate
Healthcare
Financial Services
{
"policy_number": "POL-2025-4821",
"effective_date": "2025-01-01",
"expiration_date": "2026-01-01",
"document_type": "declaration-page",
"state": "CT",
"line_of_business": "commercial-property"
}
{
"file_number": "FILE-2025-10042",
"document_type": "closing-disclosure",
"property_address": "1847 Maple Drive, Pasadena, CA 91101",
"closing_date": "2025-03-15",
"transaction_type": "purchase",
"county": "Los Angeles"
}
{
"member_id": "MBR-2025-44210",
"document_type": "explanation-of-benefits",
"service_date": "2025-02-10",
"provider_npi": "1234567890",
"claim_type": "medical",
"facility": "Lakeside Medical Center"
}
{
"loan_number": "LN-2025-78300",
"document_type": "loan-estimate",
"origination_date": "2025-02-01",
"loan_program": "conventional-30yr",
"property_type": "single-family",
"loan_amount": "485000"
}
If your dock has a metadata schema configured, artifact metadata is validated at upload time. Artifacts that fail validation are rejected with a 400 error detailing which fields are invalid.
Listing Artifacts
Retrieve all artifacts in your dock, newest first:
curl https://api.docyard.io/v1/docks/dock_01HQ3K.../artifacts \
-H "Authorization: Bearer dk_live_a1b2c3d4..."
Next Steps
