- AIAnalytics
- Send a message to the AI AssistView and receive a context-aware response.POST
- Get marksmanship coaching analysis for a competition entry.POST
- Get available report templates for a context type.GET
- Get suggested prompts for a context type.GET
- Get user's AI conversation history.GET
- Get a conversation's message history.GET
- Delete a conversation.DELETE
- Send a message to the AI AssistView and receive a context-aware response.
- AIChat
- Athletes
- AthleteProfileImage
- AthleteSocialMediaProfiles
- CameraInstances
- CameraProfiles
- CalendarEvents
- Gets all calendar events for an organization within an optional date range.
- Creates a new calendar event. Requires ManageCalendar permission.
- Gets calendar events filtered for a specific athlete. Only returns events that are organization-wide, assigned to athlete's teams, or athlete-specific (e.g., birthdays).
- Gets a specific calendar event by ID.
- Updates an existing calendar event. Requires ManageCalendar permission.
- Deletes a calendar event (soft delete). Requires ManageCalendar permission.
- Gets birthday events for athletes in the organization for a specific year.
- Gets competition/match events hosted by the organization within a date range.
- Gets a calendar subscription feed in iCalendar (ICS) format. Can be used to subscribe to the calendar in mobile devices and other calendar apps.
- Competition
- Gets all public competitions available for registration.
- Gets all competitions.
- Creates a new competition.
- Gets a competition by its unique identifier.
- Updates an existing competition.
- Deletes a competition.
- Gets competitions by league season ID.
- Updates the status of a competition.
- Gets all competitions relevant to an organization (hosted and where members participate).
- Creates a new competition for a specific organization.
- Gets competitions where a specific organization has athletes registered as participants. This differs from the /organization/{organizationId} endpoint which returns hosted competitions.
- Gets competitions by invite code (for private competitions).
- Competitions
- Gets all public competitions available for registration.
- Gets competitions by invite code (for private competitions).
- Gets a specific competition by ID (available to public).
- Gets all competitions for a specific organization (hosted and where members participate).
- Creates a new competition for an organization (Admin only).
- Updates a competition for an organization (Admin only).
- Deletes a competition for an organization (Admin only).
- CompetitionClassification
- Gets all classifications for a competition.
- Creates a new classification for a competition.
- Gets a specific classification by ID.
- Updates an existing classification.
- Deletes a classification.
- Automatically assigns athletes to classifications based on rules.
- Gets classification assignment statistics for a competition.
- Applies a classification template to a competition.
- CompetitionEntry
- Gets entries for a specific competition.
- Gets entries for a specific athlete.
- Gets entries for a specific organization.
- Creates a new competition entry.
- Checks if an athlete is already registered for a competition.
- Gets a specific competition entry by ID.
- Updates an existing competition entry.
- Deletes a competition entry.
- Checks in a competition entry.
- CompetitionRelay
- Gets all relays for a competition.
- Creates a new relay for a competition.
- Gets a specific relay by ID.
- Updates an existing relay.
- Deletes a relay.
- Gets athletes assigned to a specific relay.
- Assigns an athlete to a relay.
- Removes an athlete from a relay.
- Automatically assigns athletes to relays to balance the load.
- Balances athlete assignments across all relays.
- Clears all relay assignments for a competition.
- Gets relay statistics for a competition.
- CompetitionScore
- Gets scores for a specific competition.
- Gets scores for a specific competition entry.
- Creates a new competition score.
- Gets a specific competition score by ID.
- Updates an existing competition score.
- Deletes a competition score.
- Verifies a competition score.
- Finalizes a competition score.
- Submits a remote competition score from Nexus app for virtual/postal/remote matches.
- CompetitionShot
- Conference
- Contacts
- Conversations
- Gets all conversations for the authenticated user.
- Creates a new conversation (1:1 or group).
- Gets a specific conversation by ID.
- Adds members to an existing conversation (admin only).
- Removes a member from a conversation (admin or self).
- Updates the last read timestamp for the user in a conversation.
- Mutes or unmutes a conversation for the user.
- Gets the total unread message count for the user across all conversations.
- CorporateSponsors
- CourseOfFire
- Disciplines
- Division
- EquipmentProfiles
- Gets all equipment profiles for a specific athlete.
- Creates a new equipment profile for an athlete.
- Gets a single equipment profile by ID.
- Updates an existing equipment profile.
- Deletes an equipment profile.
- Gets all firearms for a specific equipment profile.
- Updates the firearms associated with an equipment profile.
- Firearms
- Gets all firearms for a specific athlete.
- Creates a new firearm for an athlete.
- Gets a single firearm by ID.
- Updates an existing firearm.
- Deletes a firearm.
- Gets all position settings for a firearm.
- Creates new position settings for a firearm.
- Gets a single position setting by ID.
- Updates existing position settings.
- Deletes position settings.
- FundraisingCampaigns
- FundraisingContactDNC
- Adds a contact to the Do Not Contact list. This endpoint can be called by users who want to opt out of fundraising communications.
- Removes a contact from the Do Not Contact list. This endpoint allows users to opt back into fundraising communications.
- Checks if an email is on the Do Not Contact list.
- Gets all Do Not Contact records (Admin only).
- FundraisingEmployerOrganizations
- Gets all fundraising employer-organization relationships.
- Creates a new fundraising employer-organization relationship.
- Gets fundraising employer-organization relationships for a specific employer.
- Gets fundraising employer-organization relationships for a specific organization.
- Gets a specific fundraising employer-organization relationship by ID.
- Updates an existing fundraising employer-organization relationship.
- Deletes a fundraising employer-organization relationship.
- FundraisingEmployers
- GeneratedReports
- Generate a new AI report.
- Get a generated report by ID.
- Update a generated report.
- Delete a generated report.
- List user's generated reports.
- List reports for an organization (for org owners).
- Get download URL for Word document.
- Get download URL for PDF document.
- Regenerate Word document for a report.
- Regenerate PDF document for a report.
- HeartRate
- Starts a new heart rate monitoring session for an athlete.
- Gets a heart rate session by ID.
- Updates a heart rate session (notes, end session).
- Deletes a heart rate session and all its readings.
- Gets all sessions for an athlete.
- Gets all active sessions for a competition.
- Gets all currently active heart rate monitoring sessions.
- Ends a heart rate monitoring session.
- Submits a single heart rate reading to a session. This is the primary endpoint for Apple Watch to send heart rate data.
- Gets all readings for a session.
- Submits multiple heart rate readings to a session (batch upload). Useful when connectivity is intermittent.
- Gets the latest reading for a session.
- Gets heart rate statistics for a session.
- Gets heart rate statistics for an athlete across all sessions.
- League
- Location
- MatchStage
- Starts a match stage.
- Completes a match stage.
- Gets the current timer state for a match's active stage.
- Gets all stages for a match.
- Creates a new stage for a match.
- Gets a specific stage by ID.
- Updates an existing stage.
- Deletes a stage (soft delete).
- Pauses a match stage.
- Resumes a paused match stage.
- Resets a match stage and clears all associated shots. This will delete all shots from Echelon's database and broadcast a reset command to Nexus clients.
- Generates stages automatically from the competition's course of fire.
- Me
- Returns every active organization-role assignment for the signed-in user.
- Returns the current user's profile including their linked athlete ID (if any). Used by Falken Pulse to identify the athlete for heart rate monitoring.
- Returns all permissions the current user has across all organizations.
- Returns permissions for the current user in a specific organization.
- Checks if the current user has a specific permission in an organization.
- Messages
- NewsArticle
- Get all news articles for an organization.
- Create a new news article.
- Get a specific news article by ID.
- Update an existing news article.
- Delete a news article.
- Get a specific news article by slug.
- Publish a news article.
- Get trending news articles for an organization.
- Track a view for a news article.
- Upload a featured image for a news article.
- NewsArticleAI
- NewsAuthor
- NewsCategory
- OrganizationAddresses
- /api/organizations/{organizationId}/addresses
- /api/organizations/{organizationId}/addresses
- /api/organizations/{organizationId}/addresses/{id}
- Get range addresses for a specific organization.
- /api/organizations/{organizationId}/addresses/{id}
- /api/organizations/{organizationId}/addresses/{id}
- List all organization addresses globally.
- List organization addresses filtered by Falken.Axios.Enums.AddressType.
- OrganizationContacts
- OrganizationLogos
- OrganizationRosters
- Organizations
- Get all organizations (admin only - for system administration purposes). Regular users should use GET /api/organizations/me to get their organizations.
- Create a new organization (admin only).
- Get all organizations the current authenticated user has access to.
- Get all organizations for a specific organization type (admin only).
- Get an organization by ID. User must have access to the organization.
- Update an organization (admin only).
- Delete an organization (admin only).
- Get payment settings for an organization.
- Create payment settings for an organization.
- Update payment settings for an organization.
- Delete payment settings for an organization.
- Verify payment capabilities for an organization.
- OrganizationFirearms
- Gets all firearms for a specific organization. Accessible by: Org Admin, Technical Director, Athletes (athletes should filter to their assigned firearms in client).
- Creates a new firearm for an organization. Requires: Org Admin role.
- Gets a single firearm by ID.
- Updates an existing firearm. Requires: Org Admin role.
- Deletes a firearm (soft delete). Requires: Org Admin role.
- Assigns a firearm to an athlete. Requires: Org Admin role.
- Unassigns a firearm from its current athlete. Requires: Org Admin role.
- Gets the assignment history for a specific firearm. Shows all past and current assignments of the firearm to athletes.
- Gets all assignment history records for an athlete within an organization. Shows all firearms the athlete has been assigned over time.
- OrganizationTeams
- /api/organizations/{organizationId}/teams
- /api/organizations/{organizationId}/teams
- /api/organizations/{organizationId}/teams/{id}
- /api/organizations/{organizationId}/teams/{id}
- /api/organizations/{organizationId}/teams/{id}
- /api/organizations/{organizationId}/teams/{teamId}/members
- /api/organizations/{organizationId}/teams/{teamId}/members
- /api/organizations/{organizationId}/teams/{teamId}/members/{memberId}
- /api/organizations/{organizationId}/teams/{teamId}/members/{memberId}
- /api/organizations/{organizationId}/teams/search
- OrganizationTypes
- OrganizationUsers
- Get all users and their roles for an organization (basic, without Auth0 details).
- Get all users and their roles for an organization with full user details from Auth0. Includes name, email, avatar, and other profile information.
- Get roles for a specific user in an organization.
- Assign a role to a user in an organization.
- Remove a role from a user in an organization.
- Get all available roles that can be assigned.
- OrionImport
- Password
- PlatformFeeConfiguration
- Gets all platform fee configurations (global and org-specific).
- Creates a new platform fee configuration. Restricted to system administrators only.
- Gets a specific platform fee configuration by ID.
- Updates an existing platform fee configuration. Restricted to system administrators only.
- Deletes a platform fee configuration. Restricted to system administrators only.
- Gets the applicable fee configuration for a transaction type and organization.
- Calculates the platform fee for a given amount.
- Range
- Gets all ranges.
- Creates a new range.
- Gets a range by its unique identifier.
- Updates an existing range.
- Deletes a range.
- Gets ranges by organization ID.
- Updates a range's online status.
- Gets all firing points for a range.
- Creates a new firing point for a range.
- Gets a firing point by its unique identifier.
- Updates an existing firing point.
- Deletes a firing point.
- Updates a firing point's online status.
- Registrations
- ReportTemplates
- ReservedTerm
- Rules
- RuleSections
- Rulebooks
- RulebookVersions
- SanctioningBody
- Create a new sanctioning body, optionally with a logo upload.
- Get all sanctioning bodies.
- Create a new sanctioning body.
- Get all active sanctioning bodies.
- Update an existing sanctioning body, optionally with a new logo.
- Get a specific sanctioning body by ID.
- Update an existing sanctioning body.
- Delete a sanctioning body (soft delete - sets state to Deleted).
- Upload and set the logo for an existing sanctioning body.
- Season
- ShootingJournal
- SocialAccounts
- SocialMediaConnection
- Gets all social media connections for an organization.
- Initiates OAuth connection flow for a social media platform.
- Completes OAuth connection flow after user authorization.
- Disconnects a social media account.
- Refreshes an expired access token.
- Validates a connection and returns its current status.
- Exchanges Facebook authorization code and returns available pages for selection. Combines token exchange and page fetching to avoid authorization code reuse.
- Gets all available Facebook Pages that a user can connect.
- Completes Facebook connection with a specific selected page.
- Exchanges Facebook authorization code and returns available Instagram Business accounts for selection. Combines token exchange and account fetching to avoid authorization code reuse.
- Gets all available Instagram Business accounts that a user can connect.
- Completes Instagram connection with a specific selected Instagram Business account.
- SocialMediaImage
- SocialMediaProvider
- SocialPosts
- Get all social posts for an organization.
- Create a new social post (draft or scheduled).
- Get a specific social post by ID.
- Update an existing social post.
- Delete a social post.
- Get posts scheduled within a date range (for calendar view).
- Publish a post immediately.
- Cancel a scheduled post.
- Get activity logs for a specific social post.
- StripeConnect
- StripeWebhook
- TargetScoring
- TeamRegistration
- Gets team registrations for a specific competition.
- Gets team registrations for a specific organization team.
- Creates a new team registration.
- Gets a specific team registration by ID.
- Updates an existing team registration.
- Deletes a team registration.
- Confirms a pending team registration.
- Rejects a pending team registration.
- Adds an athlete to a team registration.
- Removes an athlete from a team registration.
- Updates the designated scorers for a team registration.
- TwitterIntegration
- UserAvatars
- Upload an avatar image. Only jpg, png and webp are allowed.
- Get all avatars for a user (self or admin only).
- Upload an avatar image. Only jpg, png and webp are allowed.
- Get all avatars for a user (self or admin only).
- Delete an avatar (soft delete). Only the user or an admin may delete.
- Delete an avatar (soft delete). Only the user or an admin may delete.
- Permanently delete an avatar (admin only).
- Permanently delete an avatar (admin only).
- Mark an avatar as the current profile image (self or admin).
- Mark an avatar as the current profile image (self or admin).
- UserDeviceSession
- Creates or updates a user device session.
- Validates a user device session.
- Gets all sessions for the specified user.
- Revokes a specific device session.
- Revokes all user sessions except the current one.
- Revokes all user sessions including the current one (force logout everywhere).
- Updates the last used timestamp for a session.
- UserKeys
- Gets the authenticated user's own encrypted private keys (for PIN unlock). Returns encrypted identity key and all pre-keys with salt and nonce.
- Gets the key bundle for a specific user (for X3DH key agreement). Includes identity key, signed pre-key, and one-time pre-key if available.
- Uploads or updates the user's identity key (encrypted with PIN).
- Uploads pre-keys (signed pre-key and one-time pre-keys) for X3DH.
- Gets the count of available one-time pre-keys for the authenticated user.
- Rotates the signed pre-key (creates a new one and expires old ones). Should be done periodically (e.g., every 30 days).
- UserProfiles
- VanityUrl
- Weather
- Schemas
- Schemas
- AddressType
- ArticleStatus
- AssignRoleRequest
- AthleteResponse
- AthleteUpsertRequest
- Audience
- ChangePasswordRequest
- Country
- FalkenTextRequest
- Gender
- ImageDescriptionResponse
- KeyPhraseExtractionResponse
- LanguageDetectionResponse
- NewsArticleRequest
- NewsArticleResponse
- NewsAuthorRequest
- Falken.Axios.Models.TargetScoring.ShotResult
- NewsAuthorResponse
- Falken.Axios.Models.TargetScoring.ShotScoreSet
- NewsCategoryRequest
- NewsCategoryResponse
- NewsImageUploadResponse
- Organization
- Falken.Axios.Requests.FalkenAI.ChatCompletionRequest
- OrganizationAddress
- Falken.Axios.Requests.FalkenAI.ChatMessageDto
- OrganizationAddressRequest
- Falken.Axios.Requests.FalkenAI.CompletionRequest
- OrganizationAddressResponse
- Falken.Axios.Requests.FalkenAI.EmbeddingRequest
- OrganizationContactRequest
- Falken.Axios.Requests.FalkenAI.FalkenTextRequest
- OrganizationContactResponse
- Falken.Axios.Requests.FalkenAI.ImageGenerationRequest
- OrganizationLogo
- Falken.Axios.Requests.FalkenAI.ModerationRequest
- OrganizationLogoResponse
- OrganizationLogoType
- OrganizationRequest
- OrganizationResponse
- OrganizationRole
- OrganizationRoleResponse
- OrganizationRosterRequest
- OrganizationRosterResponse
- OrganizationTeamMemberRequest
- OrganizationTeamMemberResponse
- OrganizationTeamRequest
- OrganizationTeamResponse
- OrganizationType
- OrganizationTypeRequest
- OrganizationTypeResponse
- OrganizationUser
- OrganizationUserResponse
- ProblemDetails
- ReservedTermRequest
- ReservedTermResponse
- ReservedTermValidationRequest
- ReservedTermValidationResponse
- ReservedTermViolation
- SentimentAnalysisResponse
- SocialMediaProviderRequest
- SocialMediaProviderResponse
- SocialProfileRequest
- SocialProfileResponse
- TeamStatus
- UsStateTerritory
- UserAvatarInfoResponse
- UserAvatarResponse
- UserProfileResponse
- UserProfileUpdateRequest
- VanityUrlValidationResponse
- Falken.Axios.Responses.AzureAI.ImageDescriptionResponse
- Falken.Axios.Responses.AzureAI.KeyPhraseExtractionResponse
- Falken.Axios.Responses.AzureAI.LanguageDetectionResponse
- Falken.Axios.Responses.AzureAI.SentimentAnalysisResponse
- Falken.Axios.Responses.FalkenAI.AudioTranscribeResponse
- Falken.Axios.Responses.FalkenAI.AudioTranslateResponse
- Falken.Axios.Responses.FalkenAI.ChatCompletionResponse
- Falken.Axios.Responses.FalkenAI.CompletionResponse
- Falken.Axios.Responses.FalkenAI.EmbeddingResponse
- Falken.Axios.Responses.FalkenAI.ImageGenerationResponse
- Falken.Axios.Responses.FalkenAI.ModelsResponse
- Falken.Axios.Responses.FalkenAI.ModerationResponse
- Falken.Axios.Enums.AddressType
- Falken.Axios.Enums.ArticleStatus
- Falken.Axios.Enums.AirRifleCategory
- Falken.Axios.Enums.AthleteProfileImageType
- Falken.Axios.Enums.Audience
- Falken.Axios.Enums.CampaignScope
- Falken.Axios.Enums.CompetitionEntryStatus
- Falken.Axios.Enums.CalendarEventType
- Falken.Axios.Enums.Country
- Falken.Axios.Enums.ClassificationMode
- Falken.Axios.Enums.CameraInstanceStatus
- Falken.Axios.Enums.Gender
- Falken.Axios.Enums.ClassificationRuleType
- Falken.Axios.Enums.OrganizationLogoType
- Falken.Axios.Enums.ClassificationType
- Falken.Axios.Enums.ClassYear
- Falken.Axios.Enums.PaymentStatus
- Falken.Axios.Enums.ComparisonOperator
- Falken.Axios.Enums.RulePenaltyCode
- Falken.Axios.Enums.RulebookState
- Falken.Axios.Enums.CompetitionStatus
- Falken.Axios.Enums.SanctioningBodyState
- Falken.Axios.Enums.CompetitionType
- Falken.Axios.Enums.CmpQualification
- Falken.Axios.Enums.TeamStatus
- Falken.Axios.Enums.UsStateTerritory
- Falken.Axios.Enums.FeeStructure
- Falken.Axios.Enums.ConnectionStatus
- Falken.Axios.Enums.FirearmType
- Falken.Axios.Enums.MatchFormat
- Falken.Axios.Enums.EstType
- Falken.Axios.Requests.Athlete.AthleteSocialMediaProfileRequest
- Falken.Axios.Enums.MarksmanshipStyle
- Falken.Axios.Requests.Athlete.AthleteUpsertRequest
- Falken.Axios.Enums.PaymentOnboardingStatus
- Falken.Axios.Requests.Athlete.SocialProfileRequest
- Falken.Axios.Enums.PaymentProvider
- Falken.Axios.Enums.RegistrationQuestionType
- Falken.Axios.Enums.RegistrationStatus
- Falken.Axios.Enums.OrganizationFirearmStatus
- Falken.Axios.Enums.ScoreSelectionMode
- Falken.Axios.Requests.Fundraising.CampaignUpsertRequest
- Falken.Axios.Enums.RecurrencePattern
- Falken.Axios.Requests.Fundraising.ContactImportRequest
- Falken.Axios.Enums.PoeStandard
- Falken.Axios.Requests.Fundraising.ContactRequest
- Falken.Axios.Models.TargetScoring.EnhancedScoringResult
- Falken.Axios.Enums.ShootingPosition
- Falken.Axios.Requests.Fundraising.FundraisingContactDNCRequest
- Falken.Axios.Models.TargetScoring.EnhancedShotResult
- Falken.Axios.Requests.Fundraising.FundraisingEmployerOrganizationRequest
- Falken.Axios.Requests.Fundraising.FundraisingEmployerRequest
- Falken.Axios.Requests.Marksmanship.CreateCompetitionRequest
- Falken.Axios.Requests.Athlete.ShootingJournalEntryRequest
- Falken.Axios.Requests.Athlete.EquipmentProfileRequest
- Falken.Axios.Requests.Marksmanship.CreateFiringPointRequest
- Falken.Axios.Requests.Auth.CreateUserDeviceSessionRequest
- Falken.Axios.Requests.Marksmanship.CreateLeagueConferenceRequest
- Falken.Axios.Requests.Auth.ValidateUserDeviceSessionRequest
- Falken.Axios.Enums.SocialPlatform
- Falken.Axios.Requests.Marksmanship.CreateLeagueDivisionRequest
- Falken.Axios.Requests.Marksmanship.CreateLeagueRequest
- Falken.Axios.Requests.Athlete.FirearmPositionSettingsRequest
- Falken.Axios.Requests.Marksmanship.CreateRangeRequest
- Falken.Axios.Requests.Athlete.FirearmRequest
- Falken.Axios.Enums.SwitchClass
- Falken.Axios.Requests.Marksmanship.UpdateCompetitionRequest
- Falken.Axios.Requests.Marksmanship.UpdateFiringPointOnlineStatusRequest
- Falken.Axios.Requests.Marksmanship.UpdateFiringPointRequest
- Falken.Axios.Enums.VideoProtocol
- Falken.Axios.Requests.Marksmanship.UpdateLeagueConferenceRequest
- Falken.Axios.Requests.Athlete.EquipmentProfileFirearmsRequest
- Falken.Axios.Requests.Marksmanship.UpdateLeagueDivisionRequest
- Falken.Axios.Requests.Marksmanship.UpdateLeagueRequest
- Falken.Axios.Requests.Marksmanship.UpdateRangeOnlineStatusRequest
- Falken.Axios.Requests.Marksmanship.UpdateRangeRequest
- Falken.Axios.Requests.AI.AIAssistRequest
- Falken.Axios.Requests.News.NewsArticleRequest
- Falken.Axios.Requests.AI.AIChatRequest
- Falken.Axios.Requests.News.NewsAuthorRequest
- Falken.Axios.Requests.AI.CoachingAnalysisRequest
- Falken.Axios.Requests.News.NewsCategoryRequest
- Falken.Axios.Requests.Marksmanship.AddAthleteRequest
- Falken.Axios.Requests.AI.GenerateNewsArticleRequest
- Falken.Axios.Requests.News.SocialMediaProviderRequest
- Falken.Axios.Requests.Marksmanship.CompetitionEntryRequest
- Falken.Axios.Requests.AI.GenerateReportRequest
- Falken.Axios.Requests.Organizations.OrganizationAddressRequest
- Falken.Axios.Requests.Marksmanship.CompetitionScoreRequest
- Falken.Axios.Requests.AI.ReportTemplateRequest
- Falken.Axios.Requests.Organizations.OrganizationContactRequest
- Falken.Axios.Requests.Marksmanship.CreateClassificationRuleRequest
- Falken.Axios.Requests.AI.UpdateReportRequest
- Falken.Axios.Requests.Organizations.OrganizationRequest
- Falken.Axios.Requests.Marksmanship.CreateCompetitionClassificationRequest
- Falken.Axios.Requests.Organizations.OrganizationRosterRequest
- Falken.Axios.Requests.Marksmanship.CreateCompetitionRelayRequest
- Falken.Axios.Requests.Organizations.OrganizationTeamMemberRequest
- Falken.Axios.Requests.Organizations.OrganizationTeamRequest
- Falken.Axios.Requests.Marksmanship.CreateCourseOfFirePositionRequest
- Falken.Axios.Requests.Health.HeartRateReadingBatchRequest
- Falken.Axios.Requests.Organizations.OrganizationTypeRequest
- Falken.Axios.Requests.Marksmanship.CreateCourseOfFireRequest
- Falken.Axios.Requests.Health.HeartRateReadingRequest
- Falken.Axios.Requests.ReservedTermRequest
- Falken.Axios.Requests.Health.StartHeartRateSessionRequest
- Falken.Axios.Requests.ReservedTermValidationRequest
- Falken.Axios.Requests.Marksmanship.CreateIndividualRegistrationRequest
- Falken.Axios.Requests.Health.UpdateHeartRateSessionRequest
- Falken.Axios.Requests.Rulebooks.DisciplineRequest
- Falken.Axios.Requests.Rulebooks.RulebookRequest
- Falken.Axios.Requests.Rulebooks.RulebookVersionRequest
- Falken.Axios.Requests.SanctioningBodyRequest
- Falken.Axios.Requests.Marksmanship.CreateCompetitionShotRequest
- Falken.Axios.Requests.User.ChangePasswordRequest
- Falken.Axios.Requests.Marksmanship.CreateTeamRegistrationRequest
- Falken.Axios.Requests.User.UserProfileUpdateRequest
- Falken.Axios.Requests.Marksmanship.RegistrationAnswerRequest
- Falken.Axios.Requests.Marksmanship.CameraInstanceRequest
- Falken.Axios.Responses.Athlete.AthleteProfileImageResponse
- Falken.Axios.Requests.Marksmanship.TeamRegistrationRequest
- Falken.Axios.Requests.Marksmanship.CameraProfileRequest
- Falken.Axios.Responses.Athlete.AthleteResponse
- Falken.Axios.Requests.Marksmanship.UpdateClassificationRuleRequest
- Falken.Axios.Responses.Athlete.AthleteSocialMediaProfileResponse
- Falken.Axios.Requests.Marksmanship.UpdateCompetitionClassificationRequest
- Falken.Axios.Responses.Athlete.SocialProfileResponse
- Falken.Axios.Requests.Marksmanship.UpdateCompetitionRelayRequest
- Falken.Axios.Requests.Marksmanship.CreateMatchStageRequest
- Falken.Axios.Requests.Marksmanship.RemoteCompetitionScoreSubmissionRequest
- Falken.Axios.Responses.Fundraising.CampaignResponse
- Falken.Axios.Responses.Fundraising.ContactImportResponse
- Falken.Axios.Responses.Fundraising.ContactResponse
- Falken.Axios.Requests.Organizations.OrganizationPaymentSettingsRequest
- Falken.Axios.Responses.Fundraising.CorporateSponsorResponse
- Falken.Axios.Responses.Fundraising.FundraisingContactDNCResponse
- Falken.Axios.Requests.Marksmanship.UpdateMatchStageRequest
- Falken.Axios.Responses.Fundraising.FundraisingEmployerOrganizationResponse
- Falken.Axios.Responses.Fundraising.FundraisingEmployerResponse
- Falken.Axios.Responses.Marksmanship.CompetitionDetailResponse
- Falken.Axios.Requests.Messaging.CreateConversationRequest
- Falken.Axios.Responses.Marksmanship.CompetitionEntryResponse
- Falken.Axios.Requests.Messaging.OneTimePreKeyRequest
- Falken.Axios.Responses.Marksmanship.CompetitionRelayResponse
- Falken.Axios.Requests.Messaging.SendMessageRequest
- Falken.Axios.Responses.Marksmanship.CompetitionResponse
- Falken.Axios.Requests.Payments.CheckoutLineItem
- Falken.Axios.Requests.Messaging.SignedPreKeyRequest
- Falken.Axios.Responses.Marksmanship.FiringPointResponse
- Falken.Axios.Requests.Payments.CreateCheckoutSessionRequest
- Falken.Axios.Requests.Messaging.UploadPreKeysRequest
- Falken.Axios.Responses.Marksmanship.LeagueConferenceResponse
- Falken.Axios.Requests.Payments.PlatformFeeConfigurationRequest
- Falken.Axios.Requests.Messaging.UploadUserKeysRequest
- Falken.Axios.Responses.Marksmanship.LeagueDetailResponse
- Falken.Axios.Responses.Marksmanship.LeagueDivisionDisciplineResponse
- Falken.Axios.Responses.Marksmanship.LeagueDivisionResponse
- Falken.Axios.Requests.Organizations.AssignOrganizationFirearmRequest
- Falken.Axios.Responses.Marksmanship.LeagueDivisionRulebookResponse
- Falken.Axios.Requests.Organizations.CalendarEventRequest
- Falken.Axios.Responses.Marksmanship.LeagueOrganizationResponse
- Falken.Axios.Requests.Organizations.CreateOrganizationFirearmRequest
- Falken.Axios.Responses.Marksmanship.LeaguePersonnelResponse
- Falken.Axios.Responses.Marksmanship.LeagueResponse
- Falken.Axios.Responses.Marksmanship.LeagueSeasonResponse
- Falken.Axios.Responses.Auth.UserDeviceSessionResponse
- Falken.Axios.Responses.Athlete.ShootingJournalEntryResponse
- Falken.Axios.Responses.Marksmanship.RangeDetailResponse
- Falken.Axios.Responses.Athlete.EquipmentProfileResponse
- Falken.Axios.Responses.Marksmanship.RangeResponse
- Falken.Axios.Responses.News.NewsArticleResponse
- Falken.Axios.Responses.News.NewsAuthorResponse
- Falken.Axios.Responses.News.NewsCategoryResponse
- Falken.Axios.Responses.News.NewsImageUploadResponse
- Falken.Axios.Requests.Organizations.UpdateOrganizationFirearmRequest
- Falken.Axios.Responses.News.SocialMediaProviderResponse
- Falken.Axios.Responses.Organizations.OrganizationAddressResponse
- Falken.Axios.Responses.Organizations.OrganizationContactResponse
- Falken.Axios.Responses.Organizations.OrganizationLogoResponse
- Falken.Axios.Responses.Athlete.FirearmPositionSettingsResponse
- Falken.Axios.Responses.Organizations.OrganizationResponse
- Falken.Axios.Responses.Athlete.FirearmResponse
- Falken.Axios.Responses.Organizations.OrganizationRoleResponse
- Falken.Axios.Responses.Organizations.OrganizationRosterResponse
- Falken.Axios.Responses.Organizations.OrganizationTeamMemberResponse
- Falken.Axios.Responses.Organizations.OrganizationTeamResponse
- Falken.Axios.Responses.Organizations.OrganizationTypeResponse
- Falken.Axios.Requests.SanctioningBodyWithLogoRequest
- Falken.Axios.Responses.Organizations.OrganizationUserResponse
- Falken.Axios.Requests.Social.ConnectSocialAccountRequest
- Falken.Axios.Responses.Organizations.VanityUrlValidationResponse
- Falken.Axios.Requests.Social.MediaAttachmentRequest
- Falken.Axios.Responses.ReservedTermResponse
- Falken.Axios.Requests.Social.ScheduledPostVariationRequest
- Falken.Axios.Responses.ReservedTermValidationResponse
- Falken.Axios.Responses.Location.Location
- Falken.Axios.Requests.Social.SocialPostRequest
- Falken.Axios.Responses.ReservedTermViolation
- Falken.Axios.Responses.Marksmanship.ClassificationRuleResponse
- Falken.Axios.Requests.Social.TwitterPostRequest
- Falken.Axios.Responses.Rulebooks.DisciplineResponse
- Falken.Axios.Responses.Marksmanship.ClassificationStatistic
- Falken.Axios.Responses.Rulebooks.RuleResponse
- Falken.Axios.Responses.Marksmanship.ClassificationStatisticsResponse
- Falken.Axios.Responses.Rulebooks.RuleSectionResponse
- Falken.Axios.Responses.Marksmanship.CompetitionClassificationResponse
- Falken.Axios.Responses.Rulebooks.RulebookResponse
- Falken.Axios.Requests.Rulebooks.RuleRequest
- Falken.Axios.Responses.Rulebooks.RulebookVersionResponse
- Falken.Axios.Responses.Marksmanship.CompetitionDisciplineResponse
- Falken.Axios.Requests.Rulebooks.RuleSectionRequest
- Falken.Axios.Responses.SanctioningBodyResponse
- Falken.Axios.Responses.User.UserAvatarInfoResponse
- Falken.Axios.Responses.Location.ReverseGeocodeResponse
- Falken.Axios.Responses.User.UserAvatarResponse
- Falken.Axios.Responses.User.UserProfileResponse
- Falken.Axios.Responses.Marksmanship.CompetitionScoreResponse
- Falken.Echelon.Controllers.Admin.UpdateSponsorRequest
- Falken.Axios.Responses.Marksmanship.CompetitionShotResponse
- Falken.Echelon.Controllers.Organizations.AddSponsorRequest
- Falken.Axios.Responses.Marksmanship.CourseOfFirePositionResponse
- Falken.Echelon.Controllers.Organizations.AssignRoleRequest
- Falken.Axios.Responses.Marksmanship.CourseOfFireResponse
- Falken.Echelon.Data.Entities.Organizations.Organization
- Falken.Echelon.Data.Entities.Organizations.OrganizationAddress
- Falken.Axios.Responses.Marksmanship.IndividualRegistrationResponse
- Falken.Echelon.Data.Entities.Organizations.OrganizationLogo
- Falken.Echelon.Data.Entities.Organizations.OrganizationRole
- Falken.Echelon.Data.Entities.Organizations.OrganizationType
- Falken.Echelon.Data.Entities.Organizations.OrganizationUser
- Falken.Echelon.Models.Athletes.AthleteProfileImageResponse
- Microsoft.AspNetCore.Mvc.ProblemDetails
- Falken.Axios.Responses.Marksmanship.PublicCompetitionResponse
- Falken.Axios.Responses.Health.HeartRateBroadcastDto
- Falken.Axios.Responses.Health.HeartRateReadingResponse
- Falken.Axios.Responses.AI.AIAssistResponse
- Falken.Axios.Responses.Marksmanship.RegistrationQuestionResponse
- Falken.Axios.Responses.Health.HeartRateSessionResponse
- Falken.Axios.Responses.AI.AIChatResponse
- Falken.Axios.Responses.Marksmanship.RelayStatistic
- Falken.Axios.Responses.Authorization.AllUserPermissionsResponse
- Falken.Axios.Responses.AI.AIConversationHistoryResponse
- Falken.Axios.Responses.Marksmanship.RelayStatisticsResponse
- Falken.Axios.Responses.Authorization.UserPermissionsResponse
- Falken.Axios.Responses.AI.AIConversationMessageResponse
- Falken.Axios.Responses.Marksmanship.TeamRegistrationAthleteResponse
- Falken.Axios.Responses.AI.AIConversationSummaryResponse
- Falken.Axios.Responses.Marksmanship.TeamRegistrationResponse
- Falken.Axios.Responses.AI.AITokenUsage
- Falken.Axios.Responses.Marksmanship.WaiverTemplateResponse
- Falken.Axios.Responses.AI.AvailableTemplateInfo
- Falken.Axios.Responses.AI.CoachingAnalysisResponse
- Falken.Axios.Responses.AI.GenerateNewsArticleResponse
- Falken.Axios.Responses.AI.GeneratedReportListResponse
- Falken.Axios.Responses.AI.GeneratedReportResponse
- Falken.Axios.Responses.AI.GeneratedReportSummaryResponse
- Falken.Axios.Responses.Marksmanship.CameraInstanceResponse
- Falken.Axios.Responses.AI.PositionAnalysis
- Falken.Axios.Responses.Marksmanship.CameraProfileResponse
- Falken.Axios.Responses.AI.ReportDownloadResponse
- Falken.Axios.Responses.AI.ReportTemplateListResponse
- Falken.Axios.Responses.Organizations.OrganizationPaymentSettingsResponse
- Falken.Axios.Responses.AI.ReportTemplateResponse
- Falken.Axios.Responses.AI.ReportTemplateSummaryResponse
- Falken.Axios.Responses.AI.ShotPatternAnalysis
- Falken.Axios.Responses.Athlete.AthletePerformanceResponse
- Falken.Axios.Responses.Marksmanship.MatchStageDto
- Falken.Axios.Responses.Athlete.CompetitionResult
- Falken.Axios.Responses.Athlete.ConsistencyMetrics
- Falken.Axios.Responses.Athlete.GroupingTrendPoint
- Falken.Axios.Responses.Athlete.MatchTypeScoreTrend
- Falken.Axios.Responses.Marksmanship.StageTimerUpdateDto
- Falken.Axios.Responses.Athlete.PerformancePeriod
- Falken.Axios.Responses.Athlete.PerformanceSummary
- Falken.Axios.Responses.Athlete.PersonalRecords
- Falken.Axios.Responses.Payments.PlatformFeeConfigurationResponse
- Falken.Axios.Responses.Athlete.PositionGrouping
- Falken.Axios.Responses.Payments.StripeAccountStatusResponse
- Falken.Axios.Responses.Messaging.ConversationMemberResponse
- Falken.Axios.Responses.Athlete.PositionPerformance
- Falken.Axios.Responses.Payments.StripeCheckoutSessionResponse
- Falken.Axios.Responses.Messaging.ConversationResponse
- Falken.Axios.Responses.Athlete.ScoreDistributionBucket
- Falken.Axios.Responses.Payments.StripeOnboardingLinkResponse
- Falken.Axios.Responses.Messaging.MessageResponse
- Falken.Axios.Responses.Athlete.ScoreTrendPoint
- Falken.Axios.Responses.Messaging.OneTimePreKeyResponse
- Falken.Axios.Responses.Marksmanship.RemoteCompetitionScoreSubmissionResponse
- Falken.Axios.Responses.Messaging.SignedPreKeyResponse
- Falken.Axios.Responses.Athlete.ShotGroupingAnalysis
- Falken.Axios.Responses.Messaging.UserKeyBundleResponse
- Falken.Axios.Responses.Athlete.ShotPlotPoint
- Falken.Axios.Responses.Weather.WeatherResponse
- Falken.Axios.Responses.Messaging.EncryptedKeyInfo
- Falken.Axios.Responses.Messaging.EncryptedPreKeyInfo
- Falken.Axios.Responses.Organizations.CalendarEventResponse
- Falken.Axios.Responses.Messaging.UserEncryptedKeysResponse
- Falken.Axios.Responses.Organizations.OrganizationFirearmAssignmentHistoryResponse
- Falken.Axios.Responses.Organizations.OrganizationFirearmResponse
- Falken.Axios.Responses.Social.FacebookPageOption
- Falken.Axios.Responses.Social.InstagramAccountOption
- Falken.Axios.Responses.Social.MediaAttachmentResponse
- Falken.Axios.Responses.Social.ScheduledPostVariationResponse
- Falken.Axios.Responses.Social.SocialAccountConnectionResult
- Falken.Axios.Responses.Social.SocialAccountResponse
- Falken.Axios.Responses.Social.SocialMediaImageResponse
- Falken.Axios.Responses.Social.SocialMediaConnectionDto
- Falken.Axios.Responses.Social.SocialPostLogResponse
- Falken.Axios.Responses.Social.SocialPostResponse
- Falken.Axios.Responses.Social.TwitterPostResult
- Falken.Echelon.Controllers.Social.CompleteWithInstagramAccountRequest
- Falken.Echelon.Controllers.Social.CompleteWithPageRequest
- Falken.Axios.Responses.User.MeProfileResponse
- Falken.Echelon.Models.Athletes.AthleteProfileImageUploadRequest
- Falken.Echelon.Controllers.Marksmanship.UpdateTeamScorersRequest
- Schemas
Generate a news article using AI.
POST
https://api.falken.ltd/api/ai/news/generate
Last modified:2026-01-10 11:29:37
Request
Authorization
or
Body Params application/json
Examples
Responses
🟢200OK
application/json
Body
🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.falken.ltd/api/ai/news/generate' \
--header 'Content-Type: application/json' \
--data-raw '{
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"articleType": "string",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"year": 0,
"customInstructions": "string",
"tone": "string"
}'Response Response Example
200 - Example 1
{
"contentHtml": "string",
"contentMarkdown": "string",
"suggestedTitle": "string",
"suggestedExcerpt": "string",
"articleType": "string",
"model": "string",
"provider": "string",
"generatedAt": "2019-08-24T14:15:22.123Z",
"inputTokens": 0,
"outputTokens": 0
}Modified at 2026-01-10 11:29:37