API reference

PULSE’s API is gRPC. The contracts are the .proto files in grpc/api/proto/pulse/v1/: pulse.proto, activity.proto, and commons.proto, in package pulse.v1. Browsers use gRPC-Web on the same port.

There is no REST API, no webhook registration, and no client library besides 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.

HTTP endpoints

Analysis

Diagnostic, Radar, Insights, Customer360

Content

Content, Studio, Avatar, Course, Publishing

Campaigns and results

Campaign, Metrics, Analytics, FollowUp

Leads and accounts

Lead, Integration, Influencer

AI and platform

Model, Activity, Identity, Config, Twin, SelfHeal, Metering

Shared components

Billing, Connections, Runners, Profile, Access

Common types

User, pagination, Channel, statuses, StreamChunk

Every registered service

Service	Page
`pulse.v1.DiagnosticService`	Analysis
`pulse.v1.RadarService`	Analysis
`pulse.v1.InsightsService`	Analysis
`pulse.v1.Customer360Service`	Analysis
`pulse.v1.ContentService`	Content
`pulse.v1.StudioService`	Content
`pulse.v1.AvatarService`	Content
`pulse.v1.CourseService`	Content
`pulse.v1.PublishingService`	Content
`pulse.v1.CampaignService`	Campaigns and results
`pulse.v1.MetricsService`	Campaigns and results
`pulse.v1.AnalyticsService`	Campaigns and results
`pulse.v1.FollowUpService`	Campaigns and results
`pulse.v1.LeadService`	Leads and accounts
`pulse.v1.IntegrationService`	Leads and accounts
`pulse.v1.InfluencerService`	Leads and accounts
`pulse.v1.ModelService`	AI and platform
`pulse.v1.ActivityService`	AI and platform
`pulse.v1.IdentityService`	AI and platform
`pulse.v1.ConfigService`	AI and platform
`pulse.v1.TwinService`	AI and platform
`pulse.v1.SelfHealService`	AI and platform
`pulse.v1.MeteringService` (deprecated)	AI and platform
`runink.ui.billing.v1.BillingService`	Shared components
`runink.ui.datasources.v1.ConnectionsService`, `RunnersService`	Shared components
`runink.ui.profile.v1.ProfileService`	Shared components
`runink.ui.access.v1.AccessService`	Shared components

Conventions

Authentication. Every method needs authorization: Bearer <accessToken>, except IdentityService/Login, ModelService/GetModelStatus, and gRPC reflection.
Scoping. Data is scoped to the signed-in user. Request fields named user_id (for example in GetConfigRequest and ListIntegrationsRequest) do not let you read another user’s data.
Streaming. AI generators return stream StreamChunk. See Common types.
Pagination. List methods that paginate take PaginationRequest and return PaginationResponse.
Errors. Standard gRPC status codes with a human-readable message. See Troubleshooting.