> ## 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. # Get Project Creation References > Retrieves reference data including available engines, locations, devices, frequencies, and AI generation rules. The engines are the ones this organization and caller may use: an analysis created with any other engine is refused. ## OpenAPI ````yaml https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/references 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/references: get: tags: - Projects summary: Get Project Creation References description: >- Retrieves reference data including available engines, locations, devices, frequencies, and AI generation rules. The engines are the ones this organization and caller may use: an analysis created with any other engine is refused. operationId: get_project_references 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 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReferencesResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: ReferencesResponse: properties: engines: items: $ref: '#/components/schemas/EngineReferenceResponse' type: array title: Engines description: Available search and AI engines. locals: items: $ref: '#/components/schemas/LocalReferenceResponse' type: array title: Locals description: Available country/language combinations, sorted by country name. devices: items: $ref: '#/components/schemas/DeviceReferenceResponse' type: array title: Devices description: Available device types. frequencies: items: $ref: '#/components/schemas/FrequencyReferenceResponse' type: array title: Frequencies description: Available collection frequency options. ai_generation_custom_rules: items: $ref: '#/components/schemas/AiRuleReferenceResponse' type: array title: Ai Generation Custom Rules description: Available AI generation custom rules for keyword generation. type: object required: - engines - locals - devices - frequencies - ai_generation_custom_rules title: ReferencesResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError EngineReferenceResponse: properties: id: type: string title: Id description: Source identifier (e.g. 'google', 'chatgpt'). label: type: string title: Label description: Human-readable engine label. description: type: string title: Description description: Short description of the engine. group: type: string title: Group description: Engine group (e.g. 'AI Search', 'Traditional Search'). generations: type: integer nullable: true title: Generations description: Credits billed per generation. Null if not applicable. nb_items_per_generation: type: integer nullable: true title: Nb Items Per Generation description: Number of queries per credit unit. Null if not applicable. type: object required: - id - label - description - group title: EngineReferenceResponse LocalReferenceResponse: properties: country: type: string title: Country description: ISO 3166-1 alpha-2 country code. country_label: type: string title: Country Label description: Human-readable country name. language: type: string title: Language description: BCP 47 language code. language_label: type: string title: Language Label description: Human-readable language name. type: object required: - country - country_label - language - language_label title: LocalReferenceResponse DeviceReferenceResponse: properties: id: type: string title: Id description: Device identifier (e.g. 'desktop'). label: type: string title: Label description: Human-readable device label. type: object required: - id - label title: DeviceReferenceResponse FrequencyReferenceResponse: properties: id: type: string title: Id description: Frequency identifier (e.g. 'WEEKLY', 'MONTHLY', 'ONCE'). label: type: string title: Label description: Human-readable frequency label. description: type: string title: Description description: Short description of what this frequency means. type: object required: - id - label - description title: FrequencyReferenceResponse AiRuleReferenceResponse: properties: id: type: string title: Id description: Rule identifier. label: type: string title: Label description: Human-readable rule label. category: type: string title: Category description: Category grouping for this rule. description: type: string title: Description description: Description of what this rule targets. type: object required: - id - label - category - description title: AiRuleReferenceResponse 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.