openapi: 3.0.0
info:
  title: Lightdash AiAgents Share links API
  version: 0.3156.1
  description: 'Open API documentation for all public Lightdash API endpoints. # Authentication Before you get started, you might need to create a Personal Access Token to authenticate via the API. You can create a token by following this guide: https://docs.lightdash.com/references/personal_tokens

    '
  license:
    name: MIT
  contact:
    name: Lightdash Support
    email: support@lightdash.com
    url: https://docs.lightdash.com/help-and-contact/contact/contact_info/
servers:
- url: /
tags:
- name: Share links
paths:
  /api/v1/share/{nanoId}:
    get:
      operationId: getShareUrl
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiShareResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Get a share url from a short url id
      summary: Get share URL
      tags:
      - Share links
      security: []
      parameters:
      - description: the short id for the share url
        in: path
        name: nanoId
        required: true
        schema:
          type: string
  /api/v1/share:
    post:
      operationId: CreateShareUrl
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiShareResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Given a full URL generates a short url id that can be used for sharing
      summary: Create share URL
      tags:
      - Share links
      security: []
      parameters: []
      requestBody:
        description: a full URL used to generate a short url id
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateShareUrl'
              description: a full URL used to generate a short url id
components:
  schemas:
    Pick_ShareUrl.path-or-params_:
      properties:
        path:
          type: string
          description: The URL path of the full URL
        params:
          type: string
      required:
      - path
      - params
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    CreateShareUrl:
      $ref: '#/components/schemas/Pick_ShareUrl.path-or-params_'
      description: Contains the detail of a full URL to generate a short URL id
    ApiShareResponse:
      properties:
        results:
          $ref: '#/components/schemas/ShareUrl'
        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.'
    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'
    ShareUrl:
      properties:
        host:
          type: string
        url:
          type: string
        shareUrl:
          type: string
        organizationUuid:
          type: string
          format: uuid
        createdByUserUuid:
          type: string
          format: uuid
        params:
          type: string
        path:
          type: string
          description: The URL path of the full URL
        nanoid:
          type: string
          description: Unique shareable id
      required:
      - params
      - path
      - nanoid
      type: object
      description: 'A ShareUrl maps a short shareable id to a full URL

        in the Lightdash UI. This allows very long URLs

        to be represented by short ids.'
  securitySchemes:
    session_cookie:
      type: apiKey
      in: cookie
      name: connect.sid
    api_key:
      type: apiKey
      in: header
      name: Authorization
      description: Value should be 'ApiKey <your key>'