Skip to main content
POST
/
v1
/
sessions
curl --request POST \
  --url https://api.synthra.ai/v1/sessions \
  --header 'Authorization: Bearer synthra_live_abc123def456' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "user_9f8e7d6c5b4a",
    "metadata": {
      "source": "web",
      "language": "en"
    },
    "contextConfig": {
      "maxTokens": 8192,
      "compressionEnabled": true,
      "retentionPolicy": "semantic"
    }
  }'

{
  "sessionId": "session_abc123def456",
  "userId": "user_9f8e7d6c5b4a",
  "createdAt": "2024-03-08T14:30:00Z",
  "expiresAt": "2024-03-09T14:30:00Z",
  "messageCount": 0,
  "tokenUsage": {
    "total": 0,
    "prompt": 0,
    "completion": 0
  }
}

​
Authorization

​
Authorization
string
required
Bearer token. Format: Bearer synthra_live_abc123def456

​
Body Parameters

​
userId
string
required
Unique identifier for the user. Format: user_<16 chars>
​
metadata
object
Optional metadata to attach to the session.Example: { "source": "web", "language": "en" }
​
contextConfig
object
Context window configuration.Properties:
  • maxTokens (number): Maximum context window size. Default: 4096
  • compressionEnabled (boolean): Enable automatic compression. Default: true
  • retentionPolicy (string): Strategy for message retention. Options: fifo, priority, semantic

​
Response

​
sessionId
string
Unique session identifier. Format: session_<16 chars>
​
userId
string
User identifier associated with this session
​
createdAt
string
ISO 8601 timestamp of session creation
​
expiresAt
string
ISO 8601 timestamp when session will auto-expire (24 hours)
​
messageCount
number
Current number of messages in session. Initially 0.
​
tokenUsage
object
Token usage statisticsProperties:
  • total (number): Total tokens used
  • prompt (number): Tokens in prompts
  • completion (number): Tokens in completions
curl --request POST \
  --url https://api.synthra.ai/v1/sessions \
  --header 'Authorization: Bearer synthra_live_abc123def456' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "user_9f8e7d6c5b4a",
    "metadata": {
      "source": "web",
      "language": "en"
    },
    "contextConfig": {
      "maxTokens": 8192,
      "compressionEnabled": true,
      "retentionPolicy": "semantic"
    }
  }'

{
  "sessionId": "session_abc123def456",
  "userId": "user_9f8e7d6c5b4a",
  "createdAt": "2024-03-08T14:30:00Z",
  "expiresAt": "2024-03-09T14:30:00Z",
  "messageCount": 0,
  "tokenUsage": {
    "total": 0,
    "prompt": 0,
    "completion": 0
  }
}