Beta Documentation
This documentation is for the Synaptiq API beta. Features and APIs may change without notice. Please provide feedback to help us improve.
Getting Started
The Researcher's Guide to Synaptiq
This guide will help you get started with the Synaptiq API for scientific research and applications.
1. Create an API Key
To use the Synaptiq API, you'll need to create an API key. This key authenticates your requests and tracks your usage.
2. Choose a Model
Synaptiq offers several models optimized for different scientific tasks. The main models available through the API are:
synaptiq-2
Our most advanced model for general scientific tasks, with strong capabilities in physics, mathematics, and chemistry.
synaptiq-2-quantum
Specialized for quantum physics simulations and calculations, with enhanced visualization capabilities.
synaptiq-2-math
Optimized for mathematical derivations, proofs, and problem-solving with LaTeX support.
3. Make Your First API Call
You can interact with the Synaptiq API using the OpenAI SDK or direct REST API calls. Here's an example using the Python SDK:
from openai import OpenAI
client = OpenAI(
api_key=SYNAPTIQ_API_KEY,
base_url="https://api.synaptiq.contact/v1",
)
completion = client.chat.completions.create(
model="synaptiq-2",
messages=[
{"role": "user", "content": "Explain the double-slit experiment in quantum mechanics"}
]
)
print(completion.choices[0].message.content)
4. Understand Response Formats
Synaptiq can return responses in various formats, including plain text, LaTeX for mathematical expressions, and structured data for visualizations.
LaTeX for Mathematical Expressions
Request LaTeX formatting for mathematical expressions by specifying it in your prompt:
"Derive the Schrödinger equation and format all mathematics using LaTeX"
Structured Data for Visualizations
Request structured data for visualizations by specifying the format in your prompt:
"Simulate a quantum harmonic oscillator and provide the data in JSON format for visualization"
5. Explore Advanced Features
Synaptiq offers several advanced features for scientific research:
- Quantum Simulations: Run complex quantum physics simulations with visualization support
- Mathematical Derivations: Generate step-by-step mathematical proofs and derivations
- Literature Analysis: Extract insights from scientific papers and research
- Data Visualization: Create publication-ready visualizations of scientific data
Next Steps
Now that you understand the basics, explore our detailed guides for specific use cases: