Skip to main content

​
Create Ramp

Create a new ramp for uploading artifacts.

​
Endpoint

POST /ramps

​
Request

curl -X POST https://api.docyard.io/v1/ramps \
  -H "X-API-Key: dk_live_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production Ramp",
    "description": "Main upload endpoint for insurance declarations"
  }'

​
Response

{
  "ramp_id": "ramp-new-001",
  "name": "Production Ramp",
  "description": "Main upload endpoint for insurance declarations",
  "status": "active",
  "api_key": "dk_live_dist_aaaaaaaa",
  "api_secret": "dk_secret_dist_bbbbbbbb",
  "created_at": "2026-03-15T10:00:00Z"
}
Important: Save the api_key and api_secret securely. The secret is only shown once.