API Documentation

Everything you need to integrate SocioLogic into your application

Quick Start

1

Create Account

Sign up to get 100 free credits

2

Generate API Key

Get your key from the dashboard

3

Make Requests

Use the interactive playground below to test endpoints

Base URL

https://sociologic.ai/api/v1

Authentication

X-API-Key header (recommended)

X-API-Key: pl_live_your_key_here

Endpoints

GET
/personas

List Personas

List all available personas with filtering and pagination

Query Parameters

category - Filter by category

fidelity_tier - Filter by tier (standard, enhanced, premium, ultra)

min_fidelity_score - Minimum fidelity score (0-1)

tags - Comma-separated list of tags

search - Search in name, tagline, description

page - Page number (default: 1)

per_page - Results per page (1-100, default: 20)

Credits: 1 per request (list queries)

Example Request

curl -X GET "https://sociologic.ai/api/v1/personas?fidelity_tier=premium" \
  -H "X-API-Key: pl_live_your_key_here"

Try it out

GET
/personas/:slug

Get Persona

Get detailed information about a specific persona

Path Parameters

slug - The persona's unique identifier (e.g., "urban-millennial-tech")

Credits: 5 per persona (high-fidelity)

Example Request

curl -X GET "https://sociologic.ai/api/v1/personas/urban-millennial-tech" \
  -H "X-API-Key: pl_live_your_key_here"
Feature Spotlight

Memory Vectors (RAG)

Enhance persona realism with semantic memory retrieval

POST
/personas/:slug/interview

Interview Persona

Have a conversation with a persona

Request Body

{
  "message": "What do you look for when buying a new laptop?",
  "conversation_id": "optional-uuid-to-continue-conversation",
  "conversation_history": [
    { "role": "user", "content": "Previous message" },
    { "role": "assistant", "content": "Previous response" }
  ],
  "stream": false,
  "include_memory": true
}

Credits: 1 per message (interview query)

Example Request

curl -X POST "https://sociologic.ai/api/v1/personas/urban-millennial-tech/interview" \
  -H "X-API-Key: pl_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"message": "What motivates your purchasing decisions?"}'

Error Handling

400

Bad Request

Invalid request parameters or body

401

Unauthorized

Missing or invalid API key

402

Payment Required

Insufficient credits

404

Not Found

Persona not found

429

Too Many Requests

Rate limit exceeded

500

Internal Server Error

Something went wrong

Rate Limiting

Rate limits are applied per API key based on your subscription tier:

TierPer MinutePer Day
Standard601,000
Pro30010,000
Enterprise1,000100,000

Ready to get started?

Create an account and get 100 free credits to try the API

Need help with the API? Contact our team