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_iddo 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
| Service | Methods | Proto | Page |
|---|---|---|---|
pulse.v1.DiagnosticService | 7 | pulse.proto | Brand analysis and audits |
pulse.v1.AuditPipelineService | 7 | pulse.proto | Brand analysis and audits |
pulse.v1.AuditAttachmentService | 7 | attachments.proto | Brand analysis and audits |
pulse.v1.SitePreviewService | 1 | site_preview.proto | Brand analysis and audits |
pulse.v1.ContentResearchService | 4 | content_scenarios.proto | Brand analysis and audits |
pulse.v1.InsightsService | 5 | pulse.proto | Brand analysis and audits |
pulse.v1.RadarService | 12 | pulse.proto | Brand analysis and audits |
pulse.v1.SearchConsoleService | 5 | search_console.proto | Brand analysis and audits |
pulse.v1.GoogleBusinessService | 9 | gbp.proto | Brand analysis and audits |
pulse.v1.BrandSignalsService | 3 | brand_signals.proto | Brand analysis and audits |
pulse.v1.SiteChatService | 6 | site_chat.proto | Brand analysis and audits |
pulse.v1.SiteRepoService | 7 | site_repo.proto | Brand analysis and audits |
pulse.v1.CampaignService | 12 | pulse.proto | Campaigns and results |
pulse.v1.ContentPlanService | 2 | content_plan.proto | Campaigns and results |
pulse.v1.EpicService | 6 | pulse.proto | Campaigns and results |
pulse.v1.AutopilotService | 6 | autopilot.proto | Campaigns and results |
pulse.v1.AutomationService | 13 | automation.proto | Campaigns and results |
pulse.v1.MetricsService | 5 | pulse.proto | Campaigns and results |
pulse.v1.AnalyticsService | 3 | pulse.proto | Campaigns and results |
pulse.v1.GrowthPlanService | 6 | growth_plan.proto | Campaigns and results |
pulse.v1.ContentService | 14 | pulse.proto | Studio and content |
pulse.v1.StudioService | 6 | pulse.proto | Studio and content |
pulse.v1.StudioFormatService | 1 | studio_formats.proto | Studio and content |
pulse.v1.SkillService | 2 | skills.proto | Studio and content |
pulse.v1.AvatarService | 2 | pulse.proto | Studio and content |
pulse.v1.CourseService | 2 | pulse.proto | Studio and content |
pulse.v1.PublishingService | 5 | pulse.proto | Studio and content |
pulse.v1.BrandPaletteService | 2 | brand_palette.proto | Studio and content |
pulse.v1.LeadService | 19 | pulse.proto | Leads, opportunities and accounts |
pulse.v1.InboundService | 2 | growth_plan.proto | Leads, opportunities and accounts |
pulse.v1.OutreachService | 8 | outreach.proto | Leads, opportunities and accounts |
pulse.v1.OpportunityService | 9 | opportunities.proto | Leads, opportunities and accounts |
pulse.v1.InfluencerService | 4 | pulse.proto | Leads, opportunities and accounts |
pulse.v1.AICallService | 10 | aicall.proto | Leads, opportunities and accounts |
pulse.v1.IntegrationService | 10 | pulse.proto | Leads, opportunities and accounts |
pulse.v1.AgencyService | 5 | autopilot.proto | Leads, opportunities and accounts |
pulse.v1.AttributionService | 3 | attribution.proto | Leads, opportunities and accounts |
pulse.v1.ModelService | 4 | pulse.proto | AI and platform |
pulse.v1.ActivityService | 2 | activity.proto | AI and platform |
pulse.v1.IdentityService | 4 | pulse.proto | AI and platform |
pulse.v1.ConfigService | 2 | pulse.proto | AI and platform |
pulse.v1.SelfHealService | 1 | pulse.proto | AI and platform |