Skip to main content

Async Retrieve

Start an asynchronous retrieval job for large requests (50+ artifacts). Returns immediately with a job ID.

Endpoint

POST /dock/retrieve/async

Request

curl -X POST https://api.docyard.io/v1/dock/retrieve/async \
  -H "X-API-Key: dk_live_coll_aaaaaaaa" \
  -H "X-API-Secret: dk_secret_coll_bbbbbbbb" \
  -H "Content-Type: application/json" \
  -d '{
    "artifact_ids": ["art-001", "art-002", "art-003", "art-004", "art-005"],
    "keys": {
      "policy_number": "POL-12345678"
    },
    "notify_url": "https://your-server.com/webhook/docyard"
  }'

Response

{
  "job_id": "job-xyz789",
  "status": "processing",
  "total": 5,
  "estimated_completion": "2026-03-15T11:00:00Z"
}

Check Job Status

curl -X GET https://api.docyard.io/v1/dock/retrieve/jobs/job-xyz789 \
  -H "X-API-Key: dk_live_coll_aaaaaaaa"
{
  "job_id": "job-xyz789",
  "status": "completed",
  "total": 5,
  "processed": 5,
  "succeeded": 4,
  "failed": 1
}

Get Job Results

curl -X GET https://api.docyard.io/v1/dock/retrieve/jobs/job-xyz789/results \
  -H "X-API-Key: dk_live_coll_aaaaaaaa"
{
  "job_id": "job-xyz789",
  "status": "completed",
  "results": [
    {
      "artifact_id": "art-001",
      "status": "granted",
      "download_url": "https://api.docyard.io/v1/dock/download/token-abc123"
    },
    {
      "artifact_id": "art-002",
      "status": "denied"
    }
  ],
  "expires_at": "2026-03-16T11:00:00Z"
}