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

# Save a Semantic Studio source file

> Saves an edit to one source file as a commit on a change's pull request, or opens one.



## OpenAPI

````yaml https://raw.githubusercontent.com/lightdash/lightdash/refs/heads/main/packages/backend/src/generated/swagger.json post /api/v1/projects/{projectUuid}/semantic-studio/sources/file
openapi: 3.0.0
info:
  title: Lightdash API
  version: 3.286.0
  description: >
    Open API documentation for all public Lightdash API endpoints. #
    Authentication Authenticate using the Authorization header with either
    'ApiKey <personal-access-token>' or 'Bearer <service-account-token>'. Create
    a Personal Access Token by following this guide:
    https://docs.lightdash.com/references/personal_tokens Self-hosted
    provisioning can use the admin token configured with
    LD_SETUP_SERVICE_ACCOUNT_TOKEN to create scoped service accounts through the
    Service Accounts API.
  license:
    name: MIT
  contact:
    name: Lightdash Support
    email: support@lightdash.com
    url: https://docs.lightdash.com/help-and-contact/contact/contact_info/
servers:
  - url: /
security: []
tags:
  - name: My Account
    description: These routes allow users to manage their own user account.
  - name: Organizations
    description: >-
      Each user is a member of a single organization. These routes allow users
      to manage their organization. Most actions are only available to admin
      users.
  - name: Projects
    description: >-
      Projects belong to a single organization. These routes allow users to
      manage their projects, browse content, and execute queries. Users inside
      an organization might have access to a project from an organization-level
      role or they might be granted access to a project directly.
  - name: Spaces
    description: >-
      Spaces allow you to organize charts and dashboards within a project. They
      also allow granular access to content by allowing you to create private
      spaces, which are only accessible to the creator and admins.
  - name: Roles & Permissions
    description: >-
      These routes allow users to manage roles and permissions for their
      organization.
    externalDocs:
      url: https://docs.lightdash.com/references/roles
  - name: Service Accounts
    description: >-
      Create and manage machine credentials for your organization. Requires
      organization administration permission. Use predefined organization
      scopes, a custom organization role, or grants to selected projects.
      Credentials cannot grant more access than the caller holds.
  - name: Query
    description: >-
      These routes allow users to execute and manage queries against their data
      warehouse. This includes metric queries, SQL queries, and retrieving query
      results.
paths:
  /api/v1/projects/{projectUuid}/semantic-studio/sources/file:
    post:
      tags:
        - Semantic Studio
      summary: Save a Semantic Studio source file
      description: >-
        Saves an edit to one source file as a commit on a change's pull request,
        or opens one.
      operationId: saveSemanticStudioSource
      parameters:
        - in: path
          name: projectUuid
          required: true
          schema:
            $ref: '#/components/schemas/UUID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveSemanticStudioSourceRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSemanticStudioSourceSaveResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      security: []
components:
  schemas:
    UUID:
      type: string
      format: uuid
      description: |-
        Stringified UUIDv4.
        See [RFC 4112](https://tools.ietf.org/html/rfc4122)
      pattern: >-
        [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}
    SaveSemanticStudioSourceRequest:
      properties:
        threadUuid:
          type: string
          nullable: true
          description: >-
            The Studio conversation the change belongs to, so Try it sees the
            edit.
        prUrl:
          type: string
          nullable: true
          description: >-
            The change's open pull request to add the commit to, or null to open
            one.
        content:
          type: string
        path:
          type: string
      required:
        - threadUuid
        - prUrl
        - content
        - path
      type: object
    ApiSemanticStudioSourceSaveResponse:
      $ref: '#/components/schemas/ApiSuccess_SemanticStudioSourceSave_'
    ApiErrorPayload:
      properties:
        error:
          properties:
            data:
              $ref: '#/components/schemas/AnyType'
              description: Optional data containing details of the error
            message:
              type: string
              description: A friendly message summarising the error
            name:
              type: string
              description: Unique name for the type of error
            statusCode:
              type: number
              format: integer
              description: HTTP status code
          required:
            - name
            - statusCode
          type: object
        status:
          type: string
          enum:
            - error
          nullable: false
      required:
        - error
        - status
      type: object
      description: |-
        The Error object is returned from the api any time there is an error.
        The message contains
    ApiSuccess_SemanticStudioSourceSave_:
      properties:
        results:
          $ref: '#/components/schemas/SemanticStudioSourceSave'
        status:
          type: string
          enum:
            - ok
          nullable: false
      required:
        - results
        - status
      type: object
    AnyType:
      description: |-
        This AnyType is an alias for any
        The goal is to make it easier to identify any type in the codebase
        without having to eslint-disable all the time
        These are only used on legacy `any` types, don't use it for new types.
        This is added on a separate file to avoid circular dependencies.
    SemanticStudioSourceSave:
      anyOf:
        - properties:
            checked:
              type: boolean
            commitSha:
              type: string
            prAction:
              type: string
              enum:
                - opened
                - updated
            prUrl:
              type: string
            status:
              type: string
              enum:
                - saved
              nullable: false
          required:
            - checked
            - commitSha
            - prAction
            - prUrl
            - status
          type: object
        - properties:
            error:
              type: string
            status:
              type: string
              enum:
                - failed
              nullable: false
          required:
            - error
            - status
          type: object
      description: >-
        `failed` carries why the edit was not saved; `checked` is false when
        only dbt can check it, such as SQL.

````

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