Skip to main content
This is the interactive reference for the Migration API. Every endpoint below has a live playground: set your API key once and send real requests straight from the page. New here? Start with the Migration API guides for concepts and end-to-end walkthroughs, then come back to try the calls.

​
Base URL

https://app.vern.so/api/v1

​
Authentication

Every request authenticates with your API key in the x-api-key header. Create a key at Settings → API keys, then paste it into the Authorization field of any playground on this tab to send live requests. 
curl https://app.vern.so/api/v1/sources \
  -H "x-api-key: $VERN_API_KEY"
See Authentication for details and Errors & limits for the shared error model, status codes, and rate limits.

​
The flow

  1. Create a migration — POST /migrations
  2. Upload files — POST /migrations/{id}/files
  3. Generate a preview — POST /migrations/{id}/runs with { "kind": "generate" }
  4. Review — GET /migrations/{id}/preview
  5. Execute — POST /migrations/{id}/runs with { "kind": "execute" }
  6. Export — GET /migrations/{id}/exports/{slug}.csv