Skip to main content

​
API Reference

The Docyard API is a RESTful API for document distribution. This section documents all available endpoints.

​
Base URL

https://api.docyard.io/v1

​
Authentication

All endpoints require API key authentication: 
-H "X-API-Key: your_api_key"
-H "X-API-Secret: your_api_secret"
See Authentication for details.

​
Response Format

All responses return JSON: 
{
  "data": { ... },
  "metadata": { ... }
}

​
Error Format

Errors return appropriate HTTP status codes with structured responses: 
{
  "error": "error_code",
  "message": "Human-readable message",
  "details": { ... },
  "request_id": "req-abc123xyz"
}
See Errors for details.

​
API Sections

​
Artifact Types

Templates that define document types and their lock requirements.
EndpointDescription
List TemplatesGet available templates
Create TemplateCreate a new template
Get TemplateGet template details
Update TemplateUpdate a draft template
Delete TemplateDelete a draft template

​
Admin

Admin endpoints for vetting templates and managing the platform.
EndpointDescription
List Pending TemplatesGet templates awaiting review
Approve TemplateApprove a template
Reject TemplateReject a template

​
Ramps

Upload endpoints for distributors.
EndpointDescription
List RampsGet your ramps
Create RampCreate a new ramp
Upload ArtifactUpload a single artifact
Batch UploadUpload multiple artifacts
Rotate KeysRotate API keys

​
Docks

Retrieval endpoints for collectors.
EndpointDescription
List Lock TypesDiscover available lock types
SearchSearch for artifacts
RetrieveRetrieve a single artifact
Batch RetrieveRetrieve multiple artifacts
Async RetrieveStart async retrieval job

​
Artifacts

Manage uploaded artifacts.
EndpointDescription
Get ArtifactGet artifact details
Revoke ArtifactRevoke an artifact
List ArtifactsList your artifacts

​
Audit

Access audit logs.
EndpointDescription
List LogsQuery audit logs
Get Entity LogsGet logs for a specific entity

​
Rate Limits

CategoryLimit
General API1000 requests/minute
Upload (distributor)100 requests/minute
Search (collector)300 requests/minute
Retrieve (collector)100 requests/minute

​
SDKs

Official SDKs coming soon:
  • Node.js / TypeScript
  • Python
  • Go

​
Postman Collection

Download our Postman collection to explore the API: Download Postman Collection

​
Next Steps