REFERENCE • API DOCUMENTATION

API Reference

Complete reference documentation for the Synqly API. All methods, parameters, and response formats.

Base URL

https://api.synqly.com/api/v1/chat

Authentication

Synqly uses API keys for authentication. Include your API key in the x-synqly-key header:

x-synqly-key: YOUR_API_KEY

Methods

Endpoint

/create-chat

Parameters

providerstringrequired

AI provider (anthropic, openai, google, etc.)

modelTypestringrequired

Model identifier

messagesarrayrequired

Array of message objects

temperaturenumber

Sampling temperature (0-2)

max_tokensnumber

Maximum tokens to generate

streamboolean

Enable streaming responses

Example Request

JavaScript

const response = await ai.chat.create({
  provider: 'anthropic',
  model: 'claude-sonnet-4',
  messages: [
    { role: 'user', content: 'Hello!' }
  ],
  temperature: 0.7,
  max_tokens: 1000
});

console.log(response.content);

Example Response

JSON

{
  "id": "msg_abc123",
  "provider": "anthropic",
  "model": "claude-sonnet-4",
  "content": "Hello! How can I help you today?",
  "usage": {
    "prompt_tokens": 10,
    "completion_tokens": 8,
    "total_tokens": 18
  },
  "cost": 0.00024
}

Error Codes

Code	Description
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid API key
429	Rate Limit Exceeded
500	Internal Server Error
503	Service Unavailable