API Status: All Systems Operational

Developer Platform

Build powerful integrations with our comprehensive REST API, real-time webhooks, and SDK libraries. Everything you need to embed team coordination into your applications.

Get API Key Read Docs

create-topic.js

const preread = require('@preread/sdk');

const client = new preread.Client({
  apiKey: process.env.PREREAD_API_KEY
});

const topic = await client.topics.create({
  title: 'Sprint Planning',
  templateId: 'agile-sprint',
  deadline: '2024-02-01T17:00:00Z',
  contributors: ['eng-team'],
  workspace: 'engineering'
});

console.log('Topic created:', topic.url);

99.9%

Uptime SLA

<200ms

Average Response

150M+

API Calls/Month

24/7

Developer Support

Interactive API Explorer

Try our API endpoints right here with live examples and responses

POST/api/v1/topics

{
  "title": "Q1 Planning Session",
  "description": "Strategic planning for Q1 objectives",
  "template_id": "planning-template",
  "deadline": "2024-02-01T17:00:00Z",
  "contributors": ["user123", "user456"],
  "viewers": ["user789"],
  "workspace_id": "ws_abc123",
  "settings": {
    "require_all_contributors": true,
    "allow_late_submissions": false,
    "auto_generate_report": true
  }
}

Note: Create a new topic with contributors and deadlines

SDK Libraries

Official SDKs for popular programming languages and frameworks

🟢

Node.js

v2.1.0

Official

npm install @preread/sdk

🐍

Python

v1.8.0

Official

pip install preread-sdk

💎

Ruby

v1.5.0

Official

gem install preread

🐘

PHP

v1.4.0

Official

composer require preread/sdk

🔵

Go

v1.2.0

Official

go get github.com/preread/go-sdk

☕

Java

v1.1.0

Official

Maven/Gradle available

Webhook Events

Get real-time notifications when important events happen

topic.createdHigh

New topic is created

topic.deadline_reachedMedium

Topic deadline has passed

contribution.addedHigh

User contributes to a topic

report.generatedMedium

Topic report is generated

user.invitedLow

New user invited to workspace

workspace.updatedLow

Workspace settings changed

template.createdLow

New template is created

integration.connectedLow

External integration added

audit.log_createdHigh

New audit log entry

Example Webhook Payload

{
  "event": "topic.deadline_reached",
  "timestamp": "2024-01-15T17:00:00Z",
  "data": {
    "topic_id": "topic_xyz789",
    "title": "Q1 Planning Session", 
    "workspace_id": "ws_abc123",
    "contributors": [
      {
        "user_id": "user123",
        "status": "completed"
      },
      {
        "user_id": "user456", 
        "status": "pending"
      }
    ],
    "completion_rate": 0.6,
    "report_url": "https://api.preread.io/v1/topics/topic_xyz789/report"
  }
}

Rate Limits

Free Tier1,000 requests/hour

Professional10,000 requests/hour

EnterpriseUnlimited

Rate Limit Headers

X-RateLimit-Limit: 1000

X-RateLimit-Remaining: 999

X-RateLimit-Reset: 1642694400

Authentication

API Key Authentication

Include your API key in the Authorization header of every request.

Authorization: Bearer YOUR_API_KEY

OAuth 2.0

For applications acting on behalf of users, use OAuth 2.0 flow.

OAuth Documentation →

Ready to Build?

Get your API key and start integrating team coordination into your applications today.

Get API Key View Integrations