Flyn API

openapi: 3.1.0
info:
  title: Flyn API
  version: '2026-11-08'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-08: 31 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Flyn has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 1
    documentation: 30
    pages-with-code: 1
    pages-read: 2
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-08'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://www.flyn.to/api/openapi.json
  - https://www.flyn.to/docs
paths:
  /a/very/long/page:
    get:
      operationId: get_a_very_long_page
      tags:
      - A
      summary: GET /a/very/long/page
      x-source: https://www.flyn.to/api/openapi.json
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAVeryLongPageResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl, wget, python-requests, Postman and similar), else 403.\n\n**Plan:** no Pro-field gating here. The plan is the caller''s
          effective plan whichever way they authenticate (API key, OAuth token or session cookie): a member of a paying owner''s workspace has
          `team`. The link is filed in the caller''s active workspace. A session caller who may not create links there (a viewer, or a suspended
          seat) get'
  /api/conversion:
    get:
      operationId: get_api_conversion
      tags:
      - Api
      summary: Get conversion report
      x-source: https://www.flyn.to/api/openapi.json
      parameters:
      - name: clickId
        in: query
        required: true
        schema:
          type: string
        description: Click identifier
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiConversionResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_conversion
      tags:
      - Api
      summary: Ingest a conversion
      x-source: https://www.flyn.to/api/openapi.json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiConversionRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiConversionResponse'
      x-evidence:
        kind: documentation
  /api/domains:
    get:
      operationId: get_api_domains
      tags:
      - Api
      summary: Domains
      x-source: https://www.flyn.to/docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_domains
      tags:
      - Api
      summary: Add a custom domain
      x-source: https://www.flyn.to/api/openapi.json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiDomainsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiDomainsResponse'
      x-evidence:
        kind: documentation
  /api/domains/{id}:
    patch:
      operationId: patch_api_domains_id
      tags:
      - Api
      summary: Domains
      x-source: https://www.flyn.to/docs
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/domains/add:
    post:
      operationId: post_api_domains_add
      tags:
      - Api
      summary: Add a custom domain
      x-source: https://www.flyn.to/api/openapi.json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiDomainsAddRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiDomainsAddResponse'
      x-evidence:
        kind: documentation
  /api/domains/{id}/delete:
    delete:
      operationId: delete_api_domains_id_delete
      tags:
      - Api
      summary: Delete a domain
      x-source: https://www.flyn.to/api/openapi.json
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiDomainsIdDeleteResponse'
      x-evidence:
        kind: documentation
  /api/keys:
    get:
      operationId: get_api_keys
      tags:
      - Api
      summary: API keys, Bearer tokens, and how to create/revoke keys.
      x-source: https://www.flyn.to/docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_keys
      tags:
      - Api
      summary: API keys, Bearer tokens, and how to create/revoke keys.
      x-source: https://www.flyn.to/docs
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/keys/{id}:
    delete:
      operationId: delete_api_keys_id
      tags:
      - Api
      summary: API keys, Bearer tokens, and how to create/revoke keys.
      x-source: https://www.flyn.to/docs
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/links:
    get:
      operationId: get_api_links
      tags:
      - Api
      summary: Create, update, delete, and list short links with full control over slugs, tags, targeting, and OG metadata.
      x-source: https://www.flyn.to/docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_links
      tags:
      - Api
      summary: Create a link
      x-source: https://www.flyn.to/api/openapi.json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiLinksRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiLinksResponse'
      x-evidence:
        kind: documentation
  /api/links/{id}:
    delete:
      operationId: delete_api_links_id
      tags:
      - Api
      summary: Create, update, delete, and list short links with full control over slugs, tags, targeting, and OG metadata.
      x-source: https://www.flyn.to/docs
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_api_links_id
      tags:
      - Api
      summary: Create, update, delete, and list short links with full control over slugs, tags, targeting, and OG metadata.
      x-source: https://www.flyn.to/docs
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/links/{id}/qr:
    get:
      operationId: get_api_links_id_qr
      tags:
      - Api
      summary: QR Codes Render a QR code for any short link, or encode a URL, text, WiFi network, v-card, email, phone number or SMS directly.
      x-source: https://www.flyn.to/docs
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/links/bulk-create:
    post:
      operationId: post_api_links_bulk_create
      tags:
      - Api
      summary: Create many links to one destination
      x-source: https://www.flyn.to/api/openapi.json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiLinksBulkCreateRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiLinksBulkCreateResponse'
      x-evidence:
        kind: documentation
  /api/openapi.json:
    get:
      operationId: get_api_openapi_json
      tags:
      - Api
      summary: OpenAPI Spec
      x-source: https://www.flyn.to/docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/pixels:
    delete:
      operationId: delete_api_pixels
      tags:
      - Api
      summary: Retargeting Pixels
      x-source: https://www.flyn.to/docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_api_pixels
      tags:
      - Api
      summary: Retargeting Pixels
      x-source: https://www.flyn.to/docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_api_pixels
      tags:
      - Api
      summary: Update a pixel
      x-source: https://www.flyn.to/api/openapi.json
      parameters:
      - name: pixelId
        in: query
        required: true
        schema:
          type: string
        description: ID of the pixel to update
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchApiPixelsRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchApiPixelsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_pixels
      tags:
      - Api
      summary: Retargeting Pixels
      x-source: https://www.flyn.to/docs
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/postback:
    get:
      operationId: get_api_postback
      tags:
      - Api
      summary: Conversion Tracking
      x-source: https://www.flyn.to/docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/qr:
    post:
      operationId: post_api_qr
      tags:
      - Api
      summary: Encode content as a QR code
      description: 'Stateless QR encoder for seven content types: url, text, wifi, vcard, email, phone and sms. Nothing is stored or tracked.'
      x-source: https://www.flyn.to/api/openapi.json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiQrRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiQrResponse'
      x-evidence:
        kind: documentation
  /api/shorten:
    post:
      operationId: post_api_shorten
      tags:
      - Api
      summary: Quick shorten a URL
      x-source: https://www.flyn.to/api/openapi.json
      parameters:
      - name: User-Agent
        in: header
        required: false
        schema:
          type: string
        description: Checked by the bot filter when no Authorization header is sent.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiShortenRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiShortenResponse'
      x-evidence:
        kind: documentation
  /api/webhooks:
    get:
      operationId: get_api_webhooks
      tags:
      - Api
      summary: List webhooks
      description: Lists every webhook tagged with the caller's current workspace (teammates' included) plus the caller's own untagged webhooks,
        newest first. Secrets are masked for API‑key callers.
      x-source: https://www.flyn.to/api/openapi.json
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiWebhooksResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_webhooks
      tags:
      - Api
      summary: Webhooks
      x-source: https://www.flyn.to/docs
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/webhooks/{id}:
    delete:
      operationId: delete_api_webhooks_id
      tags:
      - Api
      summary: Webhooks
      x-source: https://www.flyn.to/docs
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_api_webhooks_id
      tags:
      - Api
      summary: Webhooks
      x-source: https://www.flyn.to/docs
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_webhooks_id
      tags:
      - Api
      summary: Webhooks
      x-source: https://www.flyn.to/docs
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /mcp:
    post:
      operationId: post_mcp
      tags:
      - Mcp
      summary: MCP Server
      x-source: https://www.flyn.to/docs
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetAVeryLongPageResponse:
      type: object
      properties:
        bearerAuth:
          type: array
          items: {}
    GetApiConversionResponse:
      type: object
      properties:
        conversions:
          type: string
          description: Number of conversions
        valueCents:
          type: string
          description: Total conversion value in cents
    PostApiConversionRequest:
      type: object
      properties:
        clickId:
          type: string
          description: Click identifier
        valueCents:
          type: string
          description: Conversion value in cents
      required:
      - clickId
    PostApiConversionResponse:
      type: object
      properties:
        ok:
          type: string
          description: Ingestion success flag
    PostApiDomainsRequest:
      type: object
      properties:
        domain:
          type: string
          description: Domain to add
      required:
      - domain
    PostApiDomainsResponse:
      type: object
      properties:
        domain.id:
          type: string
          description: Domain record ID
        domain.domain:
          type: string
          description: Domain name
        dnsInstructions.txt.type:
          type: string
          description: TXT record type
        dnsInstructions.txt.name:
          type: string
          description: TXT record name
        dnsInstructions.txt.value:
          type: string
          description: TXT record value
        dnsInstructions.routing.type:
          type: string
          description: CNAME record type
        dnsInstructions.routing.name:
          type: string
          description: CNAME record name
        dnsInstructions.routing.value:
          type: string
          description: CNAME record target
    PostApiDomainsAddRequest:
      type: object
      properties:
        domain:
          type: string
          description: Domain to add
      required:
      - domain
    PostApiDomainsAddResponse:
      type: object
      properties:
        domain.id:
          type: string
          description: Domain record ID
        domain.domain:
          type: string
          description: Domain name
        dnsInstructions.txt.type:
          type: string
          description: TXT record type
        dnsInstructions.txt.name:
          type: string
          description: TXT record name
        dnsInstructions.txt.value:
          type: string
          description: TXT record value
        dnsInstructions.routing.type:
          type: string
          description: CNAME record type
        dnsInstructions.routing.name:
          type: string
          description: CNAME record name
        dnsInstructions.routing.value:
          type: string
          description: CNAME record target
    DeleteApiDomainsIdDeleteResponse:
      type: object
      properties:
        ok:
          type: string
          description: Deletion success flag
    PostApiLinksRequest:
      type: object
      properties:
        url:
          type: string
          description: Destination URL
        slug:
          type: string
          description: Custom slug
      required:
      - url
    PostApiLinksResponse:
      type: object
      properties:
        id:
          type: string
          description: Link identifier
        slug:
          type: string
          description: Link slug
        shortUrl:
          type: string
          description: Shortened URL
    PostApiLinksBulkCreateRequest:
      type: object
      properties:
        url:
          type: string
          description: Destination URL
        quantity:
          type: string
          description: Number of links to create (2‑50)
        tag:
          type: string
          description: Batch tag applied to all links
      required:
      - url
      - quantity
    PostApiLinksBulkCreateResponse:
      type: object
      properties:
        created:
          type: string
          description: Number of links created
        tag:
          type: string
          description: Batch tag
        links:
          type: string
          description: Array of created links with slug and shortUrl
    PatchApiPixelsRequest:
      type: object
      properties:
        name:
          type: string
          description: New name for the pixel
        enabled:
          type: string
          description: Whether the pixel is active
    PatchApiPixelsResponse:
      type: object
      properties:
        id:
          type: string
          description: Pixel identifier
        name:
          type: string
          description: Pixel name
        enabled:
          type: string
          description: Pixel enabled flag
    PostApiQrRequest:
      type: object
      properties:
        type:
          type: string
          description: 'One of: url, text, wifi, vcard, email, phone, sms.'
        wifiSsid:
          type: string
          description: SSID for wifi QR codes.
        wifiPass:
          type: string
          description: Password for wifi QR codes.
        wifiEnc:
          type: string
          description: Encryption type for wifi QR codes (WPA, WEP, nopass).
        url:
          type: string
          description: URL to encode.
        text:
          type: string
          description: Plain text to encode.
        vcard:
          type: string
          description: vCard data to encode.
        email:
          type: string
          description: Email address to encode.
        phone:
          type: string
          description: Phone number to encode.
        sms:
          type: string
          description: SMS content to encode.
      required:
      - type
    PostApiQrResponse:
      type: object
      properties:
        type:
          type: string
          description: The requested content type.
        label:
          type: string
          description: Human‑readable label.
        payload:
          type: string
          description: Raw QR payload.
        qrDataUrl:
          type: string
          description: Data URL of the rendered QR image.
        qr:
          type: object
          description: Details of the rendered QR code (size, margin, level, colours, format, etc.).
    PostApiShortenRequest:
      type: object
      properties:
        url:
          type: string
          description: URL to shorten
        slug:
          type: string
          description: Optional custom slug
      required:
      - url
    PostApiShortenResponse:
      type: object
      properties:
        shortUrl:
          type: string
          description: Resulting short URL
        slug:
          type: string
          description: Slug used
    GetApiWebhooksResponse:
      type: object
      properties:
        webhooks:
          type: array
          description: Array of webhook objects.
  securitySchemes:
    Bearer_token:
      type: http
      scheme: bearer
      x-source: https://www.flyn.to/docs/authentication
tags:
- name: A
- name: Api
- name: Mcp
security:
- Bearer_token: []