Skip to content
API reference

API reference

The API of PULSE (Prescriptive Unified Lead & Social Engine) by Runink is gRPC, package pulse.v1. The contracts are the .proto files in grpc/api/proto/pulse/v1/. Browsers use gRPC-Web on the same port. Clients use the generated stubs (Go in grpc/api/v1/, Dart in flutter/lib/core/grpc/). The few plain HTTP routes are listed under HTTP endpoints. To call the API, see Calling the API.

The service pages below are generated from the protos and from the server’s role table (grpc/cmd/rbac_policy.go) by go run ./tools/apidoc, and a test fails when they fall behind, so every method listed is one the server has.

Conventions

  • Authentication. Every method needs authorization: Bearer <accessToken>, except the ones whose least role is “none (public)” and gRPC reflection. The browser client authenticates with a session cookie instead; see Calling the API.
  • Roles. Each method has a least role, read fresh from your account on every call: viewer for reads that spend no model time and change nothing, editor for anything that generates, writes, dials out or places a call, and admin for access and messaging settings. A call below your role fails with PermissionDenied. “Any signed-in” methods (who am I, sign out) work for an account with no role. Some methods check more than the role (an admin row, an arming switch); the page notes say which.
  • Scoping. Data is scoped to the signed-in user. Request fields named user_id do not let you read another user’s data.
  • Streaming. AI generators return stream StreamChunk. See Common types.
  • Errors. Standard gRPC status codes with a human-readable message. See Troubleshooting.

Shared services

These come from org-runink/ui and are documented on Shared components: runink.ui.billing.v1.BillingService, runink.ui.datasources.v1.ConnectionsService and RunnersService, runink.ui.profile.v1.ProfileService, runink.ui.access.v1.AccessService and runink.ui.comms.v1.CommsService.

Every service

ServiceMethodsProtoPage
pulse.v1.DiagnosticService7pulse.protoBrand analysis and audits
pulse.v1.AuditPipelineService7pulse.protoBrand analysis and audits
pulse.v1.AuditAttachmentService7attachments.protoBrand analysis and audits
pulse.v1.SitePreviewService1site_preview.protoBrand analysis and audits
pulse.v1.ContentResearchService4content_scenarios.protoBrand analysis and audits
pulse.v1.InsightsService5pulse.protoBrand analysis and audits
pulse.v1.RadarService12pulse.protoBrand analysis and audits
pulse.v1.SearchConsoleService5search_console.protoBrand analysis and audits
pulse.v1.GoogleBusinessService9gbp.protoBrand analysis and audits
pulse.v1.BrandSignalsService3brand_signals.protoBrand analysis and audits
pulse.v1.SiteChatService6site_chat.protoBrand analysis and audits
pulse.v1.SiteRepoService7site_repo.protoBrand analysis and audits
pulse.v1.CampaignService12pulse.protoCampaigns and results
pulse.v1.ContentPlanService2content_plan.protoCampaigns and results
pulse.v1.EpicService6pulse.protoCampaigns and results
pulse.v1.AutopilotService6autopilot.protoCampaigns and results
pulse.v1.AutomationService13automation.protoCampaigns and results
pulse.v1.MetricsService5pulse.protoCampaigns and results
pulse.v1.AnalyticsService3pulse.protoCampaigns and results
pulse.v1.GrowthPlanService6growth_plan.protoCampaigns and results
pulse.v1.ContentService14pulse.protoStudio and content
pulse.v1.StudioService6pulse.protoStudio and content
pulse.v1.StudioFormatService1studio_formats.protoStudio and content
pulse.v1.SkillService2skills.protoStudio and content
pulse.v1.AvatarService2pulse.protoStudio and content
pulse.v1.CourseService2pulse.protoStudio and content
pulse.v1.PublishingService5pulse.protoStudio and content
pulse.v1.BrandPaletteService2brand_palette.protoStudio and content
pulse.v1.LeadService19pulse.protoLeads, opportunities and accounts
pulse.v1.InboundService2growth_plan.protoLeads, opportunities and accounts
pulse.v1.OutreachService8outreach.protoLeads, opportunities and accounts
pulse.v1.OpportunityService9opportunities.protoLeads, opportunities and accounts
pulse.v1.InfluencerService4pulse.protoLeads, opportunities and accounts
pulse.v1.AICallService10aicall.protoLeads, opportunities and accounts
pulse.v1.IntegrationService10pulse.protoLeads, opportunities and accounts
pulse.v1.AgencyService5autopilot.protoLeads, opportunities and accounts
pulse.v1.AttributionService3attribution.protoLeads, opportunities and accounts
pulse.v1.ModelService4pulse.protoAI and platform
pulse.v1.ActivityService2activity.protoAI and platform
pulse.v1.IdentityService4pulse.protoAI and platform
pulse.v1.ConfigService2pulse.protoAI and platform
pulse.v1.SelfHealService1pulse.protoAI and platform