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

# Create a share link

> Create a new share link for a succeeded render. `channel="email"`
requires `recipientEmail`; to actually send, use `POST /v1/renders/{id}/email`.




## OpenAPI

````yaml /openapi.yaml post /v1/renders/{id}/shares
openapi: 3.1.0
info:
  title: Craftkit API
  version: 1.0.0
  description: >
    The Craftkit public REST API. Design templates with typed variables, render

    PDFs asynchronously, share and track them, and send them out for digital

    signature.


    ## Authentication


    Most endpoints authenticate with a **project API key** as a bearer token:


    ```

    Authorization: Bearer ck_live_xxxxxxxxxxxxxxxx

    ```


    Keys come in `ck_live_` (production) and `ck_test_` (test) flavours. Embed

    iframe surfaces use a short-lived **embed session JWT** instead, and the

    admin provisioning endpoint uses the deployment-wide `CRAFTKIT_ADMIN_KEY`.

    Inbound webhooks (`/v1/hooks/*`) are not bearer-authed — they are verified
    by

    an HMAC signature header.


    ## Idempotency


    `POST /v1/templates/{slug}/render` and `POST /v1/signatures` accept an

    `Idempotency-Key` request header. Retrying with the same key returns the

    original resource instead of creating (and, for signatures, billing) a

    duplicate.


    ## Errors


    Application errors use a shared envelope:


    ```json

    { "error": { "code": "invalid_request", "message": "...", "issues": { } } }

    ```


    A small number of admin/embed endpoints return a flatter shape

    (`{ "error": "invalid_credentials" }`); those are documented inline.
servers:
  - url: https://api.craftkit.dev
    description: Production
security:
  - bearerApiKey: []
tags:
  - name: Templates
    description: Create, list, fetch, republish, delete templates and enqueue renders.
  - name: Renders
    description: Poll render status, download PDFs, manage shares, email, and engagement.
  - name: Signatures
    description: >-
      Send rendered PDFs out for digital signatures via the signature service
      and track status.
  - name: Webhooks
    description: Inbound webhook receivers (HMAC-authenticated, not bearer-authed).
  - name: Embed
    description: Embed session minting, catalogs, builder templates, form submission.
  - name: Admin
    description: Org provisioning (deployment admin key only).
  - name: System
    description: Health and status.
paths:
  /v1/renders/{id}/shares:
    parameters:
      - $ref: '#/components/parameters/RenderId'
    post:
      tags:
        - Renders
      summary: Create a share link
      description: >
        Create a new share link for a succeeded render. `channel="email"`

        requires `recipientEmail`; to actually send, use `POST
        /v1/renders/{id}/email`.
      operationId: createRenderShare
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateShareBody'
            example:
              channel: link
              expiresAt: '2026-07-01T00:00:00.000Z'
      responses:
        '201':
          description: Share created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Share'
              example:
                id: 9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d
                shareToken: shr_abc123
                shareUrl: https://api.craftkit.dev/share/shr_abc123
                channel: link
                recipientEmail: null
                message: null
                expiresAt: '2026-07-01T00:00:00.000Z'
                revokedAt: null
                createdAt: '2026-06-21T10:00:00.000Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/RenderNotFound'
        '409':
          description: Render has not succeeded yet — cannot create a share.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: not_ready
                  message: Render has not succeeded yet — cannot create a share.
      security:
        - bearerApiKey: []
components:
  parameters:
    RenderId:
      name: id
      in: path
      required: true
      description: The render id.
      schema:
        type: string
        format: uuid
  schemas:
    CreateShareBody:
      type: object
      properties:
        channel:
          type: string
          enum:
            - link
            - email
          default: link
        recipientEmail:
          type: string
          format: email
          description: Required when channel is "email".
        message:
          type: string
          maxLength: 2000
        expiresAt:
          type: string
          format: date-time
    Share:
      type: object
      required:
        - id
        - shareToken
        - shareUrl
        - channel
        - createdAt
      properties:
        id:
          type: string
          format: uuid
        shareToken:
          type: string
        shareUrl:
          type: string
          format: uri
        channel:
          type: string
          enum:
            - link
            - email
        recipientEmail:
          type:
            - string
            - 'null'
          format: email
        message:
          type:
            - string
            - 'null'
        expiresAt:
          type:
            - string
            - 'null'
          format: date-time
        revokedAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
    Error:
      type: object
      description: Shared application error envelope.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            issues:
              description: Optional Zod flatten() / issues detail.
      example:
        error:
          code: invalid_request
          message: Request body did not match expected shape.
  responses:
    BadRequest:
      description: Invalid JSON or request shape.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_request
              message: Request body did not match expected shape.
    Unauthorized:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: unauthorized
              message: Missing Bearer token.
    RenderNotFound:
      description: Render not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_found
              message: Render not found.
  securitySchemes:
    bearerApiKey:
      type: http
      scheme: bearer
      description: >
        Project API key (`ck_live_…` or `ck_test_…`) presented as a bearer
        token.

        For embed partner endpoints this is the partner secret key, which is the

        same credential type.

````