> ## Documentation Index > Fetch the complete documentation index at: https://docs.shareofmodel.ai/llms.txt > Use this file to discover all available pages before exploring further. # Trigger Video Analyses > Analyze one or several videos: each eligible video gets a pending analysis, is charged its cost in Generations and has its pipeline started. The whole batch is checked against the workspace balance first -- a 402 means nothing was created or charged. Past that check each video succeeds or fails on its own: unknown and already-analyzed videos are rejected without a charge, and a video whose charge or pipeline start fails is reported as rejected with its failed analysis id. A video whose previous analysis failed can be analyzed again, at full price. 403 when video analysis is not enabled for the workspace. Restricted to editors and above. ## OpenAPI ````yaml https://openapi.shareofmodel.ai/swagger-sos.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/video-analyses openapi: 3.0.3 info: title: Share Of Model API version: v1 description: >- ## Search The Share of Search API provides visibility, presence, and ranking metrics for tracked search and AI engine sources. Use it to analyse how a project performs across keywords, thematics, competitors, and ranked URLs over time. For the previous version of the API, see the [v1 documentation](https://api.shareofsearch.jplus.io/docs/v1). servers: - description: Search - Production API url: https://api.shareofsearch.jplus.io/ security: [] tags: - name: Projects description: >- Manage analyses (projects) within a workspace. Create new analyses and list existing ones. - name: Collects description: >- Access data collection runs and their raw results. List collect runs for an analysis, or retrieve the raw data captured during each run: domain rankings, brand mentions, keyword insights, and LLM/SERP responses. - name: Overview Metrics description: >- High-level, aggregated metrics that summarise the overall performance of an analysis. Use these endpoints to get a quick picture of visibility, presence, andranking across all keywords and sources. - name: Metrics description: >- Detailed, per-entity metrics for deep-diving into specific aspects of an analysis. Break down performance by domain, brand, keyword, URL, or competitor. - name: Insights description: >- Cross-project KPIs aggregated at the workspace or organization level. These endpoints consolidate metrics from all active projects within a workspace, or across every workspace of an organization, to provide a unified view of visibility, mentions, citations, sentiment, and ranking. - name: Shopping description: >- Shopping-specific metrics for analyses that track product listings in shopping engines. Measure product visibility, pricing, merchant coverage, and share of shelf across all tracked keywords and sources. - name: Ads description: >- Sponsored-ad performance across tracked prompts and engines, including coverage, advertiser diversity, brand presence, and share of ad voice. - name: Creators description: >- YouTube creators cited as sources in AI-engine search results, enriched with channel metrics and an Influence Score. Browse creators across every project in a workspace, narrowed by country, engine, brand, category, analysis, and persona filters. - name: Video Analyses description: >- On-demand LLM analysis of an already-cited YouTube video: why it works as a citation source, the brands it treats, and an internal creator pre-brief. Price a selection before committing to it, trigger the analyses, and read the results. - name: Creator Briefs description: >- Partnership briefs written for shortlisted YouTube creators: a markdown document with its brand context, saved and edited by the user, with one version recorded per save and the diff into each version stored at write time. - name: CSV Export description: >- Generic CSV export gateway shared across features. `export_type` selects which dataset to export; each feature registers its own export types and usecases on the same CsvExportUsecase base rather than duplicating the CSV-writing/validation mechanics. paths: /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/video-analyses: post: tags: - Video Analyses summary: Trigger Video Analyses description: >- Analyze one or several videos: each eligible video gets a pending analysis, is charged its cost in Generations and has its pipeline started. The whole batch is checked against the workspace balance first -- a 402 means nothing was created or charged. Past that check each video succeeds or fails on its own: unknown and already-analyzed videos are rejected without a charge, and a video whose charge or pipeline start fails is reported as rejected with its failed analysis id. A video whose previous analysis failed can be analyzed again, at full price. 403 when video analysis is not enabled for the workspace. Restricted to editors and above. operationId: trigger_video_analyses parameters: - name: organization_id in: path required: true schema: type: string title: Organization Id - name: workspace_id in: path required: true schema: type: string title: Workspace Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TriggerVideoAnalysesRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TriggerVideoAnalysesResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: TriggerVideoAnalysesRequest: properties: creator_video_ids: items: type: string type: array title: Creator Video Ids description: >- The videos to analyze. No cap on the number of videos in one request; a video asked for twice is analyzed once. type: object required: - creator_video_ids title: TriggerVideoAnalysesRequest TriggerVideoAnalysesResponse: properties: accepted: items: $ref: '#/components/schemas/AcceptedVideoAnalysisResponse' type: array title: Accepted rejected: items: $ref: '#/components/schemas/RejectedVideoAnalysisResponse' type: array title: Rejected total_generation_charged: type: integer title: Total Generation Charged description: >- Generations the request actually spent: every accepted video plus any trigger_failed one. type: object required: - accepted - rejected - total_generation_charged title: TriggerVideoAnalysesResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError AcceptedVideoAnalysisResponse: properties: creator_video_id: type: string title: Creator Video Id video_analysis_id: type: string title: Video Analysis Id status: type: string title: Status generation_used: type: integer title: Generation Used description: Generations charged for this analysis. type: object required: - creator_video_id - video_analysis_id - status - generation_used title: AcceptedVideoAnalysisResponse RejectedVideoAnalysisResponse: properties: creator_video_id: type: string title: Creator Video Id reason: type: string title: Reason description: >- video_not_found: the platform does not know this video. already_analyzed: the workspace already has a pending, running or completed analysis of it (video_analysis_id). charge_failed: the charge was refused, so the analysis was created then failed. trigger_failed: the analysis was charged but its pipeline could not be started, so it failed with generation_used still spent. video_analysis_id: type: string nullable: true title: Video Analysis Id generation_used: type: integer nullable: true title: Generation Used description: >- Generations spent on a rejected video; only a trigger_failed one has any. type: object required: - creator_video_id - reason title: RejectedVideoAnalysisResponse ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError securitySchemes: HTTPBearer: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.