Chat API Reference - SundayPyjamas AI Suite

Overview

The Chat API is the core endpoint for conversational AI, content generation, and text completion. It provides access to powerful language models with streaming responses for real-time interactions.

This reference includes all request/response schemas, parameters, and interactive examples you can test directly.

Base URL

https://suite.sundaypyjamas.com/api/v1

Authentication

All API requests require authentication using your API key:

Authorization: Bearer spj_ai_your_api_key_here

Learn more about API key generation and management.

Endpoints

POST /chat

Send messages to AI models and receive streaming responses

Quick Example

Here’s a simple example to get you started:

curl -X POST https://suite.sundaypyjamas.com/api/v1/chat \
  -H "Authorization: Bearer spj_ai_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "role": "user",
        "content": "Hello! Write me a professional email greeting."
      }
    ]
  }'

const response = await fetch('https://suite.sundaypyjamas.com/api/v1/chat', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer spj_ai_your_api_key_here',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    messages: [
      { role: 'user', content: 'Hello! Write me a professional email greeting.' }
    ]
  })
});

const reader = response.body.getReader();
const decoder = new TextDecoder();
let result = '';

while (true) {
  const { done, value } = await reader.read();
  if (done) break;
  result += decoder.decode(value);
}

console.log(result);

import requests

response = requests.post(
    'https://suite.sundaypyjamas.com/api/v1/chat',
    headers={
        'Authorization': 'Bearer spj_ai_your_api_key_here',
        'Content-Type': 'application/json',
    },
    json={
        'messages': [
            {
                'role': 'user',
                'content': 'Hello! Write me a professional email greeting.'
            }
        ]
    },
    stream=True
)

full_response = ''
for chunk in response.iter_content(chunk_size=None, decode_unicode=True):
    if chunk:
        full_response += chunk

print(full_response)

Common Patterns

System Messages

Use system messages to set the AI’s behavior and context:

{
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant that writes professional emails."
    },
    {
      "role": "user",
      "content": "Write a follow-up email after a job interview."
    }
  ]
}

Multi-turn Conversations

Include conversation history for context:

{
  "messages": [
    {
      "role": "user",
      "content": "What's the weather like?"
    },
    {
      "role": "assistant",
      "content": "I don't have access to real-time weather data..."
    },
    {
      "role": "user",
      "content": "What about general weather patterns?"
    }
  ]
}

Content Generation

Structure prompts for specific content types:

{
  "messages": [
    {
      "role": "system",
      "content": "You are a content marketing expert. Write engaging blog posts with clear structure and actionable insights."
    },
    {
      "role": "user",
      "content": "Write a blog post about remote work productivity tips for software developers. Target length: 1000 words."
    }
  ]
}

Error Handling

All errors return a consistent format:

{
  "error": "Human-readable error message"
}

Common HTTP status codes:

400 Bad Request

Invalid request format or missing required fields.Example:

{
  "error": "Messages array is required"
}

401 Unauthorized

Invalid or missing API key.Example:

{
  "error": "Invalid API key"
}

403 Forbidden

Token limit exceeded or insufficient permissions.Example:

{
  "error": "Token limit exceeded"
}

429 Too Many Requests

Rate limit exceeded.Example:

{
  "error": "Rate limit exceeded"
}

500 Internal Server Error

Server-side error occurred.Example:

{
  "error": "Failed to generate response"
}

Rate Limits

Token-based Limits

Usage measured in tokens (input + output)

Request Rate

No hard limits, but monitored for abuse

Workspace Quotas

Monthly token limits per workspace

Concurrent Requests

Multiple simultaneous requests supported

For detailed rate limit information, see the Rate Limits guide.

Best Practices

Request Optimization

Efficient Prompting

Be specific and clear in your instructions
Use system messages to set context once
Keep conversation history relevant and concise

{
  "messages": [
    {
      "role": "system",
      "content": "You write concise, professional emails."
    },
    {
      "role": "user",
      "content": "Write a project status update email to stakeholders."
    }
  ]
}

Conversation Management

Trim old messages to stay within token limits
Keep only relevant context for the current task
Use consistent message formatting

function trimConversation(messages, maxTokens = 2000) {
  // Keep system message and recent relevant messages
  const systemMessage = messages.find(m => m.role === 'system');
  const recentMessages = messages.slice(-10); // Last 10 messages
  
  return systemMessage 
    ? [systemMessage, ...recentMessages.filter(m => m.role !== 'system')]
    : recentMessages;
}

Error Handling

Always check response status codes
Implement retry logic for transient errors
Provide user-friendly error messages

async function makeRequest(messages) {
  try {
    const response = await fetch('/api/v1/chat', {
      method: 'POST',
      headers: {
        'Authorization': `Bearer ${apiKey}`,
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({ messages })
    });

    if (!response.ok) {
      const error = await response.json();
      throw new Error(error.error);
    }

    return response;
  } catch (error) {
    console.error('API request failed:', error);
    throw error;
  }
}

SDK Libraries

JavaScript/TypeScript

Official and community libraries for Node.js and browsers

Python

Async and sync clients with full type support

Go

Community-maintained Go client library

Official SDKs are coming soon! For now, use the examples in our code examples section.

Testing Tools

API Testing

Use tools like Postman, Insomnia, or curl for testing:

# Test endpoint availability
curl -X POST https://suite.sundaypyjamas.com/api/v1/chat \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"messages": [{"role": "user", "content": "test"}]}' \
  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n"

Load Testing

For production readiness testing:

# Simple load test with ab (Apache Bench)
ab -n 100 -c 10 -T application/json \
   -H "Authorization: Bearer your_api_key" \
   -p test_payload.json \
   https://suite.sundaypyjamas.com/api/v1/chat

Support

Documentation

Comprehensive guides and examples

Community

Join discussions with other developers

Support

Contact support through your workspace

Status Page

Monitor API status and uptime

Next Steps

POST /chat Endpoint

Detailed documentation for the chat endpoint with all parameters

Code Examples

Complete implementation examples in multiple languages

Rate Limits

Understanding usage limits and optimization strategies

Error Handling

Comprehensive error handling guide and patterns

​Overview

​Base URL

​Authentication

​Endpoints

POST /chat

​Quick Example

​Common Patterns

​System Messages

​Multi-turn Conversations

​Content Generation

​Error Handling

​Rate Limits

Token-based Limits

Request Rate

Workspace Quotas

Concurrent Requests

​Best Practices

​Request Optimization

​SDK Libraries

JavaScript/TypeScript

Python

Go

​Testing Tools

​API Testing

​Load Testing

​Support

Documentation

Community

Support

Status Page

​Next Steps

POST /chat Endpoint

Code Examples

Rate Limits

Error Handling

Overview

Base URL

Authentication

Endpoints

Quick Example

Common Patterns

System Messages

Multi-turn Conversations

Content Generation

Error Handling

Rate Limits

Best Practices

Request Optimization

SDK Libraries

Testing Tools

API Testing

Load Testing

Support

Next Steps