API Documentation

Complete API reference for integrating AgentPsy's AI assessment tools into your applications.

Getting Started

Our RESTful API allows you to integrate AgentPsy's AI personality assessment capabilities into your applications. All API requests must include your API key in the Authorization header.

Authentication

To authenticate API requests, include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Base URL

All API requests are made to:

https://api.agentpsy.com/v1

Assessment Endpoints

POST

/assessments/personality

Perform a personality assessment using the Big Five model.

Request Body

{
  "text": "Sample text to analyze for personality traits",
  "model": "gpt-4",
  "evaluation_framework": "big_five"
}

Parameters

Name Type Required Description
text string Yes The text content to analyze for personality traits
model string No The AI model to use for analysis (default: gpt-4)
evaluation_framework string No The assessment framework to use (default: big_five)

Response

{
  "id": "assmt_123456789",
  "created": 1678886400,
  "model": "gpt-4",
  "result": {
    "openness": 0.72,
    "conscientiousness": 0.85,
    "extraversion": 0.61,
    "agreeableness": 0.78,
    "neuroticism": 0.34,
    "confidence": 0.89
  }
}
POST

/assessments/cognitive-stability

Evaluate cognitive stability and consistency in responses.

Request Body

{
  "text": "Sample text to analyze for cognitive stability",
  "model": "claude-3-opus",
  "context": "Additional context for evaluation"
}

Parameters

Name Type Required Description
text string Yes The text content to analyze for cognitive stability
model string No The AI model to use for analysis
context string No Additional context for the evaluation

Response

{
  "id": "assmt_987654321",
  "created": 1678886400,
  "model": "claude-3-opus",
  "result": {
    "consistency_score": 0.82,
    "stability_index": 0.76,
    "reasoning_coherence": 0.89,
    "confidence": 0.85
  }
}
POST

/assessments/cognitive-trap

Evaluate susceptibility to cognitive traps and reasoning errors.

Request Body

{
  "scenarios": [
    {
      "prompt": "Describe how you would approach this complex reasoning problem",
      "context": "Context for the reasoning task"
    }
  ],
  "model": "gpt-4"
}

Parameters

Name Type Required Description
scenarios array Yes Array of reasoning scenarios to evaluate
model string No The AI model to use for analysis

Response

{
  "id": "assmt_555566667",
  "created": 1678886400,
  "model": "gpt-4",
  "result": {
    "cognitive_trap_susceptibility": 0.45,
    "reasoning_accuracy": 0.78,
    "logical_consistency": 0.82,
    "confidence": 0.80
  }
}

Error Handling

All API responses follow standard HTTP status codes:

  • 200 OK - Request successful
  • 400 Bad Request - Invalid request parameters
  • 401 Unauthorized - Invalid or missing API key
  • 429 Too Many Requests - Rate limit exceeded
  • 500 Internal Server Error - Server error

Rate Limits

Our API has the following rate limits:

  • Free Tier: 1,000 requests per month
  • Pro Tier: 10,000 requests per month
  • Enterprise: Custom limits

Rate limits are reset at the beginning of each month.

Need Help Implementing?

Our technical team provides integration support and custom solutions for enterprise clients.

Contact Technical Support