OpenAPI Specification

Machine-readable API specification in OpenAPI 3.0 format for code generation and tooling integration.

Download Specification

Download the complete OpenAPI 3.0 specification file for the HireCharacter API. Use this file for code generation, testing, and documentation tools.

Download YAML Download JSON View HTML Docs
Interactive Documentation

Explore our API interactively using Swagger UI:

You can test API endpoints directly in this interface with your API key.

Code Generation

Use our OpenAPI specification to generate client libraries for your preferred programming language:

OpenAPI Generator

Generate clients using the official OpenAPI Generator tool.

npx @openapitools/openapi-generator-cli generate \
  -i https://hirecharacter.ai/assets/openapi/hirecharacter-api-spec.yaml \
  -g javascript \
  -o ./hirecharacter-client
Swagger Codegen

Alternative code generation using Swagger Codegen.

swagger-codegen generate \
  -i https://hirecharacter.ai/assets/openapi/hirecharacter-api-spec.yaml \
  -l python \
  -o ./python-client

Supported Languages

The OpenAPI specification can be used to generate client libraries in over 40 programming languages:

Popular Languages
  • JavaScript/TypeScript
  • Python
  • Java
  • C#/.NET
  • PHP
  • Ruby
Mobile
  • Swift (iOS)
  • Kotlin (Android)
  • Dart (Flutter)
  • React Native
Other Languages
  • Go
  • Rust
  • C++
  • Scala

Integration Examples

Postman Import

Import the OpenAPI spec directly into Postman:

  1. Open Postman and click "Import"
  2. Paste the spec URL: https://hirecharacter.ai/assets/openapi/hirecharacter-api-spec.yaml
  3. Postman will automatically generate a collection
Insomnia Import

Import into Insomnia REST client:

  1. Go to Application → Preferences → Data
  2. Click "Import Data" and select "From URL"
  3. Enter: https://hirecharacter.ai/assets/openapi/hirecharacter-api-spec.yaml
Testing Tools
Dredd API Testing
dredd https://hirecharacter.ai/assets/openapi/hirecharacter-api-spec.yaml \
     https://api.hirecharacter.ai
Newman + Postman
newman run \
  --global-var "api_key=YOUR_KEY" \
  collection.json

Specification Details

API Information
API Version: v1
OpenAPI Version: 3.0.3
Base URL: https://api.hirecharacter.ai/v1
Content Type: application/json
Specification Stats
Endpoints: 24
Models: 18
Security Schemes: 1 (Bearer Token)
File Size: ~45KB

Included Endpoints

  • GET /users - List users
  • POST /users - Create user
  • GET /users/{id} - Get user
  • PUT /users/{id} - Update user
  • DELETE /users/{id} - Delete user

  • POST /assessments - Create assessment
  • GET /assessments/{id} - Get assessment
  • GET /assessments/{id}/results - Get results
  • GET /assessments/{id}/report - Get report
  • GET /assessments - List assessments
  • PUT /assessments/{id}/status - Update status

  • POST /signals - Submit signal
  • GET /signals/search - Search signals
  • GET /signals/{id} - Get signal
  • POST /signals/{id}/flag - Flag signal
Pro Tips
  • Use the OpenAPI spec for automated testing and validation
  • Generate mock servers for development using tools like Prism
  • Integrate with CI/CD pipelines for contract testing
  • Keep your generated clients up-to-date by monitoring spec changes
Quick Links
Download YAML Download JSON Edit in Swagger Editor
Validation
OpenAPI 3.0.3 Compliant
JSON Schema Valid
Swagger UI Compatible
Code Generation Ready
Version History
Current: v1.2.0
Last Updated: Jan 15, 2025
Format: OpenAPI 3.0.3
View full changelog →
Tools & Resources