> ## Documentation Index
> Fetch the complete documentation index at: https://docs.surnex.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create the sample project

> Seeds a read-only project filled with made-up data for every feature, named after the company and pointed at its site. It runs no jobs and does not count against the plan. An organization has at most one; asking again returns it.



## OpenAPI

````yaml https://api.surnex.io/docs/openapi.json post /v1/organizations/{orgId}/projects/demo
openapi: 3.1.0
info:
  title: Surnex API
  version: 1.0.0
  description: >-
    The SEO platform's API.


    **The API is the product.** The dashboard is one client and the MCP server
    at `/mcp` is another. If a number needs deriving, a service derives it —
    never a React component, or the two clients drift.


    **Two kinds of auth.** The dashboard sends a Supabase access token as a
    Bearer JWT. MCP agents send `X-API-Key`, and the organization is resolved
    from the key.


    **Two data modes.** SERP results and Google Trends are fetched live on
    request. Everything else is written by the worker and read from Postgres, so
    a freshly-created project returns empty until its jobs complete.
servers:
  - url: https://api.surnex.io
    description: Surnex API
security: []
paths:
  /v1/organizations/{orgId}/projects/demo:
    post:
      tags:
        - projects
      summary: Create the sample project
      description: >-
        Seeds a read-only project filled with made-up data for every feature,
        named after the company and pointed at its site. It runs no jobs and
        does not count against the plan. An organization has at most one; asking
        again returns it.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: orgId
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
                domain:
                  type: string
                  pattern: ^([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)+[a-z]{2,}$
              required:
                - name
                - domain
      responses:
        '201':
          description: The sample project
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    nullable: true
                    properties:
                      id:
                        type: string
                        format: uuid
                      org_id:
                        type: string
                        format: uuid
                      name:
                        type: string
                      domain:
                        type: string
                      is_demo:
                        type: boolean
                      location_code:
                        type: integer
                      language_code:
                        type: string
                      search_engine:
                        type: string
                        enum:
                          - google
                          - bing
                          - yahoo
                          - baidu
                          - naver
                          - seznam
                      tracking_location_code:
                        type: integer
                      tracking_language_code:
                        type: string
                      ai_location_code:
                        type: integer
                      ai_language_code:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      schedules:
                        type: array
                        items:
                          type: object
                          properties:
                            jobType:
                              type: string
                              enum:
                                - rank_check
                                - backlink_snapshot
                                - geo_snapshot
                                - local_ranking_check
                            cadence:
                              type: string
                              enum:
                                - daily
                                - every_3_days
                                - weekly
                                - biweekly
                                - monthly
                            runHour:
                              type: integer
                              minimum: 0
                              maximum: 23
                            timezone:
                              type: string
                            enabled:
                              type: boolean
                            next_run_at:
                              type: string
                              format: date-time
                            last_run_at:
                              type: string
                              nullable: true
                              format: date-time
                          required:
                            - jobType
                            - cadence
                            - runHour
                            - timezone
                            - enabled
                            - next_run_at
                            - last_run_at
                    required:
                      - id
                      - org_id
                      - name
                      - domain
                      - is_demo
                      - location_code
                      - language_code
                      - search_engine
                      - tracking_location_code
                      - tracking_language_code
                      - ai_location_code
                      - ai_language_code
                      - created_at
                      - updated_at
                      - schedules
                required:
                  - success
                  - data

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.