The identity and technical contract details declared by the specification.
ActivityResponse
object
14 properties
14 required
AddCompetitorRequest
object
5 properties
2 required
AddMultipleCompetitorsRequest
object
2 properties
1 required
AgentReadinessScore
object
How AI-agent-friendly is this site?
11 properties
1 required
AgentResponse
object
15 properties
15 required
AgentSummary
object
Summary of an AI agent
10 properties
9 required
AiExportRequest
object
5 properties
AnalystReportExtraction
object
Extracted insights from an analyst report
11 properties
4 required
AnalyticsSyncRequest
object
2 properties
ApiKeyResponse
object
9 properties
9 required
ApproveStepRequest
object
Approve generated content for a step
1 property
1 required
AssistantRequest
object
3 properties
1 required
AttestationCreate
object
A signed claim about context
8 properties
2 required
AttestationEvidenceCreate
object
Evidence supporting an attestation
6 properties
1 required
BaselineProbeRequest
object
Request to run a baseline probe.
2 properties
BattlecardDetail
object
Full battlecard detail.
28 properties
9 required
BattlecardSummary
object
Summary view of a battlecard for list views.
13 properties
8 required
BlogPost
object
A detected blog post
6 properties
1 required
BlueprintSummary
object
Summary of a blueprint
6 properties
6 required
Body_analyze_g2_themes_api_competitors__competitor_id__g2_analyze_themes_post
object
2 properties
Body_analyze_pdf_api_pdfs__pdf_id__analyze_post
object
1 property
1 required
Body_create_topics_from_g2_themes_api_competitors__competitor_id__g2_create_topics_post
object
2 properties
Body_generate_content_with_pdfs_api_pdfs_generate_content_post
object
7 properties
3 required
Body_generate_observability_report_api_competitive_intel_monitor_full_report_post
object
2 properties
1 required
Body_import_json_data_api_admin_migration_import_json_post
object
1 property
1 required
Body_link_g2_product_api_competitors__competitor_id__g2_link_post
object
2 properties
1 required
Body_scan_saved_prompts_api_geo_aeo_prompts_scan_post
object
3 properties
Body_upload_document_api_onboarding_documents_upload_post
object
1 property
1 required
Body_upload_pdf_api_pdfs_upload_post
object
2 properties
1 required
BootstrapRequest
object
Request to bootstrap a new organization.
3 properties
1 required
BulkEnrichmentRequest
object
Request model for bulk enrichment
3 properties
1 required
BulkPromptCreate
object
Bulk create prompts.
1 property
1 required
BulkScheduleRequest
object
Bulk update scheduling for multiple prompts.
3 properties
2 required
CRMConfigRequest
object
CRM configuration request
3 properties
2 required
CadenceScore
object
Overall content marketing cadence score
8 properties
4 required
CampaignAddRequest
object
Add contacts to campaign request
3 properties
2 required
CareersCadence
object
Careers/hiring activity metrics
8 properties
ChampionTrackingRequest
object
Request model for champion tracking
2 properties
1 required
ChunkOptimizationRequest
object
Request for chunk optimization
4 properties
3 required
ChunkResponse
object
Response model for content chunk retrieval.
8 properties
6 required
ChunkSearchRequest
object
Request to search for content chunks.
4 properties
1 required
CompanyEnrichmentRequest
object
Request model for company enrichment
5 properties
1 required
CompetitorIntelReport
object
Full competitive intelligence report for a competitor
9 properties
4 required
CompetitorScanRequest
object
Request to scan a competitor
4 properties
2 required
CompetitorSuggestion
object
A suggested competitor
5 properties
4 required
CompetitorSummary
object
8 properties
8 required
ConfirmDiscoveryRequest
object
User-confirmed/edited discovery data
8 properties
2 required
ConfirmOnboardingRequest
object
User-confirmed onboarding data
5 properties
3 required
ConnectRequest
object
1 property
1 required
ContactSyncRequest
object
Contact sync request
4 properties
ContentCadence
object
Content publishing cadence metrics
6 properties
ContentPlatform
string
Platforms for content generation.
ContentSearchRequest
object
5 properties
ContentTone
string
Tones for generated content.
ContentTopicResponse
object
Response for a content topic.
12 properties
8 required
ContentType
string
Types of content that can be extracted.
ContentVersion
object
13 properties
13 required
ContentVersionCreate
object
7 properties
3 required
CrawlDomainRequest
object
Request to crawl a domain
3 properties
1 required
CrawlEstimateRequest
object
Request model for scan estimate.
1 property
1 required
CrawlRequest
object
Request model for crawl job.
10 properties
1 required
CrawlResponse
object
Response model for crawl job.
4 properties
4 required
CrawlSummary
object
Summary model for completed crawl.
10 properties
10 required
CrawledContentItem
object
Crawled content available for voice selection.
8 properties
7 required
CreateApiKeyRequest
object
3 properties
1 required
CreateApiKeyResponse
object
Response when creating a key - includes the full key (only shown once).
7 properties
7 required
CreateNarrativeRequest
object
8 properties
2 required
CreateRequest
object
3 properties
1 required
CreateStreamRequest
object
Request for creating a context stream
6 properties
1 required
CreateTopicsFromSignalsRequest
object
Request to create content topics from signals.
2 properties
1 required
CreateVoiceRequest
object
Request to create a new content voice.
5 properties
3 required
DEODashboardStats
object
Dashboard statistics
9 properties
9 required
DEOEventPayload
object
Single DEO event from an instrumented touchpoint
16 properties
2 required
DEOIngestRequest
object
Batch ingest request from an instrumented source
12 properties
4 required
DEOIngestResponse
object
Response from ingest endpoint
6 properties
4 required
DiscoverCompetitorsRequest
object
1 property
DiscoverDomainRequest
object
Request to discover company info from domain
1 property
1 required
DiscoverRequest
object
Request to discover Discord signals
3 properties
DiscoverSignalsRequest
object
3 properties
DiscoveryConfigRequest
object
Request model for discovery configuration
13 properties
DiscoveryData
object
Homepage discovery data
6 properties
2 required
DiscoveryInsightResponse
object
Response model for discovery insights.
9 properties
9 required
DiscoveryOverview
object
Overview of discovery system status.
8 properties
8 required
DiscoveryPatternResponse
object
Response model for discovery patterns.
7 properties
7 required
DiscoveryResult
object
Quick discovery results from a domain
8 properties
2 required
DiscoveryStateResponse
object
Response model for discovery source state.
8 properties
8 required
DriveConfigRequest
object
3 properties
3 required
EditVideoScriptRequest
object
Request to edit a saved video script
3 properties
1 required
EnrichmentData
object
Lusha enrichment data
8 properties
EventPayload
object
Single event payload from frontend.
14 properties
2 required
ExecuteRequest
object
Request to execute a blueprint
3 properties
1 required
ExportRequest
object
4 properties
2 required
ExportToDriveRequest
object
Request to export battlecard to Google Drive.
1 property
ExportToGoogleDriveRequest
object
6 properties
1 required
ExtractedMessagingFramework
object
Complete messaging framework extracted via Claude
13 properties
3 required
ExtractedPersona
object
Persona extracted from competitor messaging
4 properties
2 required
ExtractedProduct
object
Product/offering extracted from competitor
5 properties
2 required
FunnelStage
string
Sales funnel stages for content targeting.
G2ScanRequest
object
Request body for G2 scan
3 properties
GAConfigRequest
object
3 properties
1 required
GAConfigResponse
object
3 properties
2 required
GSCQueriesResponse
object
Response for search queries endpoint
7 properties
7 required
GSCQueryResponse
object
Response for a search query
5 properties
5 required
GSCSiteResponse
object
Response for a GSC site
2 properties
2 required
GenerateBattlecardRequest
object
Request to generate a new battlecard.
2 properties
1 required
GenerateContentRequest
object
Request to generate content using RAG.
12 properties
3 required
GenerateDeckRequest
object
3 properties
1 required
GenerateElementRequest
object
Request to generate a single element with AI.
5 properties
1 required
GeneratePromptsRequest
object
Request to generate GEO prompts from context.
8 properties
1 required
GenerateStepRequest
object
Request to generate content for a framework step
1 property
GenerateWithGypsumRequest
object
Request model for content generation with Gypsum + RAG integration.
9 properties
3 required
GenerateWithGypsumResponse
object
Response model for Gypsum + RAG content generation.
7 properties
7 required
GenerateWithHybridRequest
object
Request model for content generation with hybrid RAG.
7 properties
3 required
GenerateWithHybridResponse
object
Response model for hybrid RAG content generation.
6 properties
6 required
GenerateWithPositioningRequest
object
9 properties
6 required
GeneratedContent
object
Response model for generated content.
8 properties
2 required
GeneratedPrompt
object
A generated prompt suggestion enhanced with Gypsum persona insights
11 properties
11 required
GitHubRepoHealth
object
Health metrics for a GitHub repo
8 properties
1 required
GovDiscoveryRequest
object
5 properties
GovernancePolicyCreate
object
Create a governance policy
10 properties
1 required
GuidanceRequest
object
Request for visibility gap guidance.
6 properties
3 required
GypsumSyncRequest
object
Optional metadata to include when syncing from Gypsum
3 properties
HTTPValidationError
object
1 property
HealthSummaryResponse
object
6 properties
6 required
HotTopicResponse
object
11 properties
11 required
HybridSearchRequest
object
Request model for hybrid search.
5 properties
1 required
HybridSearchResponse
object
Response model for hybrid search.
5 properties
5 required
ImportAuthoritativeContentRequest
object
Request model for importing llms.txt or context.txt as authoritative content.
4 properties
4 required
ImportQueriesRequest
object
Request to import queries as target prompts
7 properties
1 required
ImportResult
object
Result of import operation
4 properties
4 required
InsightResponse
object
8 properties
8 required
IntegrationResponse
object
11 properties
11 required
InviteRequest
object
2 properties
1 required
JobPosting
object
A detected job posting
4 properties
1 required
LandscapeNormalizeRequest
object
1 property
1 required
LeaderCreate
object
5 properties
2 required
LeaderMetricsUpdate
object
All fields are measurable/verifiable.
8 properties
LinkedInCadence
object
LinkedIn activity metrics
5 properties
MCPEventContext
object
Context from standard MCP telemetry format
4 properties
2 required
MCPEventData
object
Event data from standard MCP telemetry format
5 properties
2 required
MCPTelemetryEvent
object
Single event in standard MCP telemetry format
3 properties
3 required
MCPTelemetryRequest
object
Standard MCP telemetry batch request. This is the format used by instrumented MCP servers. Any MCP server can use this format to report telemetry.
4 properties
1 required
MapOrganizationRequest
object
3 properties
1 required
MarketObservabilityReport
object
Complete marketing observability report
8 properties
3 required
MarketTrend
object
A market trend identified in the report
3 properties
1 required
MessagingData
object
Generated high-level messaging
5 properties
4 required
ModulatorCreate
object
14 properties
1 required
ModulatorUpdate
object
14 properties
MutationCreate
object
Create a new context mutation with attestations
9 properties
2 required
NotionConfig
object
3 properties
OTLPAttribute
object
OTLP attribute value wrapper
2 properties
2 required
OTLPResource
object
OTLP resource
1 property
OTLPResourceSpans
object
OTLP resource with scope spans
2 properties
OTLPScope
object
OTLP instrumentation scope
2 properties
OTLPScopeSpans
object
OTLP scope with spans
2 properties
OTLPSpan
object
OTLP span
9 properties
4 required
OTLPTraceRequest
object
OTLP/JSON trace export request
1 property
OrgKeyRequest
object
1 property
1 required
OrgListResponse
object
2 properties
2 required
OrgSettingsRequest
object
2 properties
OrgSettingsResponse
object
2 properties
OrgSummary
object
8 properties
1 required
PersonEnrichmentRequest
object
Request model for person enrichment
5 properties
1 required
PersonalityType
string
Available personality types for content generation.
PositioningComparison
object
Side-by-side positioning comparison
7 properties
2 required
ProcessContentRequest
object
Request for processing content with intelligence
6 properties
PromptGenerationRequest
object
Request for generating prompts with Gypsum integration
7 properties
PromptGenerationResponse
object
Response containing generated prompts with Gypsum insights
5 properties
5 required
PromptResponse
object
Response with generated prompts.
2 properties
2 required
ProposePersonasRequest
object
Request to propose personas based on company/product context
4 properties
2 required
ProposePersonasResponse
object
Response with proposed personas
2 properties
1 required
ProposedPersona
object
A proposed persona with their perspective
6 properties
5 required
ProspectingRequest
object
Request model for AI prospecting
8 properties
ProvenanceCreate
object
Create a provenance relationship between entities
10 properties
4 required
PublishRequest
object
Request to publish knowledge to streaming topics
4 properties
PushChunksRequest
object
2 properties
QualityProfileResponse
object
Quality profile response.
14 properties
14 required
RAGProcessRequest
object
Request model for RAG processing.
4 properties
RAGProcessResponse
object
Response model for RAG processing.
3 properties
3 required
RankingOverrideRequest
object
Request for ranking override
6 properties
2 required
RecommendationResponse
object
8 properties
4 required
RedditMention
object
A Reddit mention of a competitor
8 properties
6 required
RefreshStaleResponse
object
Response from refreshing stale battlecards.
3 properties
2 required
RegisterAgentRequest
object
6 properties
2 required
RerankRequest
object
Request for reranking chunks
3 properties
2 required
ResolveBatchRequest
object
3 properties
1 required
ResolveRequest
object
3 properties
1 required
ResumeRequest
object
2 properties
ReviewVideoScriptRequest
object
Request to review a video script
3 properties
1 required
RulesExport
object
Export format for system prompt injection
5 properties
5 required
RunRequest
object
1 property
SaveContentTopicRequest
object
Request to save a visibility gap as a content topic.
9 properties
1 required
SaveLandscapeAnalysisRequest
object
Request to save a competitive landscape analysis.
3 properties
1 required
SaveSessionRequest
object
Request to save session cookies for an AI platform.
2 properties
2 required
SaveStrategyAnalysisRequest
object
Request to save a competitor strategy analysis.
1 property
1 required
SaveVideoScriptRequest
object
Request to save a video script
3 properties
1 required
SavedVideoScriptDetail
object
Detailed view of a saved video script
20 properties
20 required
ScanJobResponse
object
Response when starting an async scan job.
3 properties
3 required
ScoreContentRequest
object
Request to score content against the quality model.
3 properties
1 required
SearchContentRequest
object
2 properties
1 required
SearchPeopleRequest
object
3 properties
1 required
SearchRequest
object
3 properties
1 required
SessionCaptureRequest
object
4 properties
4 required
SignalSyncRequest
object
Signal sync request
4 properties
SimpleOnboardingRequest
object
Start simplified onboarding with just a domain
1 property
1 required
SimpleOnboardingResponse
object
Complete response from simple onboarding discovery
5 properties
4 required
SinglePromptTestRequest
object
Request to test a single prompt.
3 properties
2 required
SourceChunk
object
Source chunk information for generated content.
4 properties
4 required
StartScanRequest
object
Request to start an async visibility scan.
3 properties
2 required
StreamingConfigRequest
object
Configuration for Kafka-compatible streaming connection (per org). Works with Redpanda, Confluent, MSK, or any Kafka-protocol broker.
15 properties
1 required
SubscribeRequest
object
Request to subscribe to topics for signal ingestion
2 properties
1 required
SyncResponse
object
4 properties
2 required
TargetPromptCreate
object
Create a new target prompt.
7 properties
2 required
TargetPromptResponse
object
Response for a target prompt.
14 properties
12 required
TargetPromptUpdate
object
Update a target prompt.
6 properties
TelemetryStatsResponse
object
Summary statistics response.
8 properties
8 required
TemplateCreateRequest
object
Request model for creating templates
7 properties
5 required
TemplateResponse
object
Response model for templates
10 properties
10 required
TemplateSearchRequest
object
Request model for searching templates
5 properties
TerminologyRule
object
12 properties
6 required
TerminologyRuleCreate
object
8 properties
2 required
TerminologyRuleUpdate
object
8 properties
TestPromptsRequest
object
Request to test prompts for visibility.
5 properties
2 required
TestSearchRequest
object
2 properties
1 required
TopicCreate
object
Create a new topic.
3 properties
1 required
TopicResponse
object
Response for a topic.
5 properties
5 required
TrackRequest
object
Request body for tracking events.
11 properties
2 required
TrackResponse
object
Response from tracking endpoint.
4 properties
4 required
TrackingEvent
object
Tracking event from website
9 properties
7 required
TrainQualityRequest
object
Request to train a quality model from gold vs baseline content.
3 properties
2 required
TrainingDataCreate
object
5 properties
2 required
TrainingDataResponse
object
10 properties
8 required
TrainingRequest
object
4 properties
2 required
TrainingSession
object
14 properties
14 required
TrainingSessionCreate
object
3 properties
3 required
TrainingSessionUpdate
object
6 properties
UpdateBattlecardStatusRequest
object
Request to update battlecard status.
1 property
1 required
UpdateCompetitorRequest
object
15 properties
UpdatePersonaRequest
object
Update a specific persona
2 properties
1 required
UpdateVoiceRequest
object
Request to update a content voice.
4 properties
ValidationError
object
5 properties
3 required
ValidationRequest
object
4 properties
1 required
ValidationResponse
object
6 properties
2 required
ValidationResult
object
3 properties
2 required
VendorMention
object
A vendor mentioned in an analyst report
6 properties
1 required
VideoGenerationRequest
object
Request for generating complete video
6 properties
1 required
VideoGenerationResponse
object
Response from video generation request
7 properties
5 required
VideoGenerationStatus
object
Status of video generation
9 properties
5 required
VideoScene
object
Individual video scene
7 properties
7 required
VideoScriptRequest
object
Request for generating video script
7 properties
VideoScriptResponse
object
Generated video script response
9 properties
9 required
VideoScriptSummary
object
Summary of a saved video script
11 properties
11 required
VisibilityReportResponse
object
Full visibility report response.
8 properties
8 required
VisibilityResultResponse
object
Response for a single prompt visibility test.
6 properties
6 required
VisibilitySnapshotResponse
object
8 properties
8 required
VoiceAnalytics
object
5 properties
5 required
VoiceResponse
object
Content voice response.
20 properties
20 required
WebflowConfig
object
1 property
WebflowItemCreate
object
1 property
1 required
WebflowPublishRequest
object
9 properties
1 required
api__battlecards__ExportResponse
object
Response from Google Drive export.
4 properties
1 required
api__export__ExportResponse
object
4 properties
2 required
api__google_auth__CallbackRequest
object
2 properties
1 required
api__hubspot_auth__CallbackRequest
object
2 properties
2 required
api__notion_integration__CallbackRequest
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.