Skip to main content

​
Create Artifacts (Batch)

Creates multiple artifact metadata records in a single request. File content is not uploaded — use batch upload for that. 
POST /v1/docks/:dockId/artifacts/batch

​
Path Parameters

ParameterTypeDescription
dockIdstringThe dock ID

​
Request Body

ParameterTypeRequiredDescription
itemsarrayRequiredArray of artifact definitions (minimum 1)
items[].filenamestringRequiredThe artifact filename
items[].metadataobjectOptionalArbitrary key-value metadata

​
Example Request

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-page-001.pdf", "metadata": { "policy_number": "POL-001" } },
      { "filename": "dec-page-002.pdf", "metadata": { "policy_number": "POL-002" } },
      { "filename": "dec-page-003.pdf", "metadata": { "policy_number": "POL-003" } }
    ]
  }'

​
Response

{
  "batchId": "batch_01HQ3S...",
  "artifacts": [
    { "id": "art_01HQ3S...", "filename": "dec-page-001.pdf", "createdAt": "2025-01-15T10:36:00.000Z" },
    { "id": "art_01HQ3T...", "filename": "dec-page-002.pdf", "createdAt": "2025-01-15T10:36:00.000Z" },
    { "id": "art_01HQ3U...", "filename": "dec-page-003.pdf", "createdAt": "2025-01-15T10:36:00.000Z" }
  ]
}

​
Error Handling

StatusCondition
400items array is empty or a required field is missing
401Missing or invalid API key
404Dock not found