Pulse LogoPulse
    Back to Docs

    Getting Started

    AuthenticationRate LimitsErrors

    Endpoints

    Agent ChatDaily BriefingCOO StrategiesEisenhower MatrixHistorical BriefingsNotes Summary
    Back to Docs

    Pulse API Documentation

    Access Pulse programmatically with our REST API. Build integrations, automate workflows, and extend your productivity tools.

    Get API KeyView Examples

    Authentication

    All API requests require authentication using an API key. Include your key in theAuthorization header:

    Authorization: Bearer YOUR_API_KEY

    You can also use the X-API-Key header as an alternative.

    Base URL

    https://api.pulse-ai.world/v1

    Rate Limits

    TierRequests/minTokens/week
    Free10/min1,200,000/week
    Pro60/min6,000,000/week
    Business300/min25,000,000/week

    Error Codes

    All errors return JSON with a consistent structure:

    {
  "error": "ERROR_CODE",
  "message": "Human-readable description",
  "timestamp": "2024-01-24T08:30:00Z"
}
    CodeHTTP StatusDescription
    UNAUTHORIZED401Invalid or missing API key
    FORBIDDEN403Token limit exceeded
    INVALID_REQUEST400Malformed request body
    RATE_LIMIT_ERROR429Too many requests
    MODEL_NOT_AVAILABLE403Model not available for tier
    INTERNAL_ERROR500Server error

    Endpoints

    POST
    /v1/chat

    Agent Chat

    Conversational AI assistant with tool execution capabilities. Supports streaming responses.

    curl -X POST https://api.pulse-ai.world/v1/chat \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "What should I focus on today?", "stream": true}'
    POST
    /v1/briefing

    Daily Briefing

    Generate a comprehensive daily briefing combining emails, calendar, todos, and notes.

    curl -X POST https://api.pulse-ai.world/v1/briefing \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"timeDuration": "last 24 hours"}'
    POST
    /v1/briefing/strategies

    COO Strategies

    Get top 3 strategic priorities based on your current context.

    curl -X POST https://api.pulse-ai.world/v1/briefing/strategies \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"statusQuoSummary": "...", "todoSummary": "..."}'
    POST
    /v1/briefing/matrix

    Eisenhower Matrix

    Categorize tasks into the 4-quadrant priority matrix.

    curl -X POST https://api.pulse-ai.world/v1/briefing/matrix \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"statusQuoSummary": "...", "todoSummary": "..."}'
    GET
    /v1/briefings

    Historical Briefings

    Retrieve past briefing summaries.

    curl -X GET "https://api.pulse-ai.world/v1/briefings?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"
    GET
    /v1/notes/summary

    Notes Summary

    Get a summary of recent notes for context.

    curl -X GET "https://api.pulse-ai.world/v1/notes/summary?limit=5" \
  -H "Authorization: Bearer YOUR_API_KEY"