Skip to content
API docs
Sign inOpen app

Get started

Quickstart

Set your key and the base URL once, then list the workspace’s forms.

Set up

Create a key (see Authentication) and keep it and the base URL in two variables. Every example in these docs uses them.

Terminal
export AYEFORM_API="https://careful-sparrow-950.convex.site"
export AYEFORM_KEY="fk_…"   # your key

Your first request

Terminal
curl "$AYEFORM_API/v1/forms" \
  -H "Authorization: Bearer $AYEFORM_KEY"

You get back an array of the workspace’s forms as JSON.

Next steps