curl -X POST https://api.docyard.io/v1/ramp/artifacts \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

{
  "ramp_id": "ramp-abc123",
  "api_key": "dk_live_dist_xxxxxxxxxxxx",
  "api_secret": "dk_secret_dist_xxxxxxxxxxxx"
}

{
  "dock_id": "dock-xyz789",
  "api_key": "dk_live_coll_aaaaaaaa",
  "api_secret": "dk_secret_coll_bbbbbbbb"
}

{
  "error": "authentication_required",
  "message": "API key and secret are required"
}

{
  "error": "invalid_api_key",
  "message": "The provided API key is invalid"
}

{
  "error": "invalid_api_secret",
  "message": "The provided API secret is incorrect"
}

{
  "error": "api_key_expired",
  "message": "The API key has expired. Please rotate your keys."
}

{
  "error": "api_key_revoked",
  "message": "The API key has been revoked"
}

curl -X POST https://api.docyard.io/v1/ramps/ramp-abc123/rotate-keys \
  -H "X-API-Key: dk_live_dist_xxxxxxxxxxxx" \
  -H "X-API-Secret: dk_secret_dist_xxxxxxxxxxxx"

{
  "new_api_key": "dk_live_dist_yyyyyyyyyyyy",
  "new_api_secret": "dk_secret_dist_yyyyyyyyyyyy",
  "old_key_expires_at": "2026-03-16T10:30:00Z"
}

curl -X POST https://api.docyard.io/v1/docks/dock-xyz789/rotate-keys \
  -H "X-API-Key: dk_live_coll_aaaaaaaa" \
  -H "X-API-Secret: dk_secret_coll_bbbbbbbb"

dk_live_*

dk_test_*

# .gitignore
api_keys.txt
.env

export DOCYARD_API_KEY="dk_live_xxxxxxxxxxxx"
export DOCYARD_API_SECRET="dk_secret_xxxxxxxxxxxx"

# Development
export DOCYARD_API_KEY="dk_test_dist_xxxxxxxxxxxx"

# Production
export DOCYARD_API_KEY="dk_live_dist_xxxxxxxxxxxx"

const docyard = require('docyard-sdk');

const client = new docyard.Client({
  apiKey: process.env.DOCYARD_API_KEY,
  apiSecret: process.env.DOCYARD_API_SECRET
});

// Upload artifact
const artifact = await client.ramp.upload({
  templateId: 'tmpl-abc123',
  locks: {
    policy_number: { value: 'POL-12345678' }
  },
  threshold: 20,
  content: pdfBuffer
});

import docyard

client = docyard.Client(
    api_key=os.environ['DOCYARD_API_KEY'],
    api_secret=os.environ['DOCYARD_API_SECRET']
)

# Upload artifact
artifact = client.ramp.upload(
    template_id='tmpl-abc123',
    locks={
        'policy_number': {'value': 'POL-12345678'}
    },
    threshold=20,
    content=pdf_bytes
)

import "github.com/docyard/docyard-go"

client := docyard.NewClient(
    os.Getenv("DOCYARD_API_KEY"),
    os.Getenv("DOCYARD_API_SECRET"),
)

// Upload artifact
artifact, err := client.Ramp.Upload(&docyard.UploadRequest{
    TemplateID: "tmpl-abc123",
    Locks: map[string]LockValue{
        "policy_number": {Value: "POL-12345678"},
    },
    Threshold: 20,
    Content:   pdfBytes,
})

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Please retry after 60 seconds.",
  "retry_after": 60
}