Skip to main content
Dev Portal Quick Start

Quick Start

Go from zero to a live API in 3 steps. Create an account, sign in, and start building your profile. Add an API key only when you need owner automation.

1

Create an Account

Register for free, then sign in to receive a JWT token. The token is used to manage your API keys.

Register

curl -X POST {{BASE_URL}}/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "username": "yourname",
    "email": "you@example.com",
    "password": "secureP@ss123",
    "full_name": "Your Name"
  }'

Sign in

curl -X POST {{BASE_URL}}/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "username": "yourname",
    "password": "secureP@ss123"
  }'

# Response: { "access_token": "eyJhbG...", "token_type": "bearer" }

Try it live: Register endpoint · Sign-in endpoint

2

Get an API Key (Optional)

Use your JWT token to create an API key only when you need long-lived automation. The key starts with rst_ and is shown only once — copy it immediately.

curl -X POST {{BASE_URL}}/v1/auth/api-keys \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -d '{"name": "my-app-key"}'

# Response: { "raw_key": "rst_a1b2c3d4e5f6...", "prefix": "rst_a1b2", ... }
Save the raw_key value now. It cannot be retrieved again — only the prefix is stored.

Try it live: Create API Key endpoint

3

Build Your Profile

Owner routes accept either a JWT bearer token or an API key. Use JWT for interactive owner calls and the CLI, or use X-API-Key when you need a dedicated automation credential.

Update Your Profile With JWT

curl -X PATCH {{BASE_URL}}/v1/me/profile \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -d '{
    "open_to_work": true
  }'

Add a Skill With an API Key

curl -X POST {{BASE_URL}}/v1/me/skills \
  -H "Content-Type: application/json" \
  -H "X-API-Key: rst_YOUR_KEY" \
  -d '{
    "name": "Python",
    "category": "Languages",
    "proficiency": "expert",
    "years_of_experience": 5
  }'

Add Experience

curl -X POST {{BASE_URL}}/v1/me/experience \
  -H "Content-Type: application/json" \
  -H "X-API-Key: rst_YOUR_KEY" \
  -d '{
    "company": "Acme Corp",
    "title": "Backend Engineer",
    "start_date": "2023-01-15",
    "is_current": true
  }'

Full owner surface: Owner API reference

What's Next?

For detailed auth flows and error handling, see the Authentication & Setup Guide.