REST API quickstart

Run an end-to-end AI customer interview workflow over HTTP: create a study from a research brief, poll the authoring job, simulate the interview, go live, mint participant invite links with context, list completed interviews, and export CSV transcripts.

10 steps6 min read

First study

1. Check API key

curl https://api.heyjuno.co/v1/api/me \
  -H "Authorization: Bearer $JUNO_API_KEY"

2. Create study

curl -X POST https://api.heyjuno.co/v1/api/studies \
  -H "Authorization: Bearer $JUNO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "guidance": "Interview churned customers about why they left" }'

3. Check study job

curl https://api.heyjuno.co/v1/api/studies/jobs/{job_id} \
  -H "Authorization: Bearer $JUNO_API_KEY"

4. Simulate interview

curl -X POST https://api.heyjuno.co/v1/api/studies/{study_id}:simulate \
  -H "Authorization: Bearer $JUNO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

5. Check simulation

curl https://api.heyjuno.co/v1/api/simulations/{job_id} \
  -H "Authorization: Bearer $JUNO_API_KEY"

6. Set study mode

curl -X PUT https://api.heyjuno.co/v1/api/studies/{study_id}/mode \
  -H "Authorization: Bearer $JUNO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "mode": "live" }'

7. Get invite link

curl https://api.heyjuno.co/v1/api/studies/{study_id}/interview-link \
  -H "Authorization: Bearer $JUNO_API_KEY"

8. List interviews

curl "https://api.heyjuno.co/v1/api/interviews?study_id={study_id}&status=completed&limit=50" \
  -H "Authorization: Bearer $JUNO_API_KEY"

9. Start an export

curl -X POST https://api.heyjuno.co/v1/api/exports \
  -H "Authorization: Bearer $JUNO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "study_id": "9b2f6c1d-4e6b-8a3f-0b6a-2f3e9d414e6b", "format": "csv" }'

10. Download the result

curl https://api.heyjuno.co/v1/api/exports/{job_id}/download \
  -H "Authorization: Bearer $JUNO_API_KEY"

Previous OAuth Next Concepts