REST API Reference

30 endpoints across 5 categories. Interactive docs with Try It forms.

Base URL

Authentication

JWT Bearer Token

Used for auth management endpoints (API key CRUD).

Send as Authorization: Bearer <token>

API Key

Used for all /v1/me/* CRUD endpoints.

Send as X-API-Key: rst_...

For step-by-step instructions, see the Authentication & Setup Guide.

Endpoint Categories

Authentication

5 endpoints

User registration, login, and API key management.

POST /v1/auth/register · POST /v1/auth/login
POST /v1/auth/api-keys · GET /v1/auth/api-keys · DELETE /v1/auth/api-keys/{'{key_id}'}

Public API

6 endpoints

Read-only access to any developer's public profile data. No auth required.

GET /v1/users/{'{username}'} · GET /v1/users/{'{username}'}/skills
GET /v1/users/{'{username}'}/experience · GET /v1/users/{'{username}'}/education
GET /v1/users/{'{username}'}/projects · GET /v1/users/{'{username}'}/resume

Authenticated CRUD

17 endpoints

Manage your profile, skills, experience, education, projects, resume import, and usage analytics. Requires X-API-Key.

GET/PATCH /v1/me/profile · POST/PUT/DELETE /v1/me/skills · POST/PUT/DELETE /v1/me/experience
POST/PUT/DELETE /v1/me/education · POST/PUT/DELETE /v1/me/projects · POST /v1/me/import/* · GET /v1/me/usage
JWT set Key set No credentials set

AI

1

Ask a natural language question about a developer

Path Parameters

FieldTypeDescription
username string Target username*

Request Body

FieldTypeDescription
question string Your question (3-500 chars)*

Response

FieldTypeDescription
answer string AI-generated answer*
username string Username queried*
answer_mode string Strategy used: deterministic, llm, no_data, insufficient_context, or fallback_unavailable*
confidence number Estimated confidence score between 0 and 1*
evidence_types array Distinct facet types used for grounding (skill, experience, project, education, profile)*
sources array Context chunks used for the answer* 

                    
                

            

            

                
                
Request

                
{
  "question": "What programming languages does this developer know?"
}

                
                
Response 200 OK

                
{
  "answer": "Based on the profile data, Hershel has documented experience with Python, Kotlin, Java, C, C++, Bash, SQL, and Swift.",
  "username": "hershel",
  "answer_mode": "deterministic",
  "confidence": 0.94,
  "evidence_types": ["skill"],
  "sources": [
    {
      "document": "Skill: Python. Category: Languages. Proficiency: expert. Years of experience: 5.",
      "metadata": {"type": "skill", "name": "Python"},
      "distance": "0.342"
    }
  ]
}

            

            
        

    






    


    
    
Health

    1




    


            
            
            
            
            
            
        


        

                
Check if the API is running

                
                
                
                
Response

                




    
FieldTypeDescription

    
    
        

            status
            string
            
            Always "healthy"*
        

    
        

            app
            string
            
            App name*
        

    
        

            version
            string
            
            API version*
        

    
    





                
                
            

                

                

                    
                    

                    
                

                
            

                

                    

                    
                

            

            

                
                
Response 200 OK

                
{
  "status": "healthy",
  "app": "restume",
  "version": "1.0.0"
}

            

            
        

    






    

        Auto-generated docs also available at
        /redoc
        and
        /openapi.json
        ·
        MCP recruiting docs