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

# Create a personal link

> Requires the `agent:write` scope.

Name a greeting (gr_…) or write a new_greeting in the same call. Darwin makes the link's id.



## OpenAPI

````yaml /api-reference/openapi.json post /personal_links
openapi: 3.1.0
info:
  title: Darwin API
  version: '2026-10-12'
  description: >-
    Read and act on your Darwin workspace: conversations, contacts, meetings,
    outcome forms and their requests, personal links and their greetings,
    analytics, knowledge, the agent, its chat buttons and its opening tests,
    with signed webhooks for what happens.


    Authenticate with a secret key from Integrations → API: `Authorization:
    Bearer dk_live_…`. Keys carry scopes; personal data needs `contacts:read`.

    Rate limits are per key per minute: origin 120, adapt 120, evolve 600, apex
    1200; heavy calls (exports, crawls, model work) have a smaller budget. Every
    response carries RateLimit-* headers.

    Lists are cursor-paginated (`limit`, `starting_after`, `next_cursor`).
    Writes accept `Idempotency-Key`. Errors are RFC 9457 problem documents with
    a stable `code` and a `request_id`.
  contact:
    name: Darwin
    url: https://docs.meetdarwin.ai/api-reference/introduction
servers:
  - url: https://api.meetdarwin.ai/v1
security:
  - bearer: []
tags:
  - name: Workspace
  - name: Conversations
  - name: Contacts
  - name: Meetings
  - name: Outcomes
  - name: Personal links
  - name: Analytics
  - name: Events
  - name: Webhooks
  - name: Knowledge
  - name: Agent
  - name: Experiments
  - name: Privacy
  - name: Chat
paths:
  /personal_links:
    post:
      tags:
        - Personal links
      summary: Create a personal link
      description: >-
        Requires the `agent:write` scope.


        Name a greeting (gr_…) or write a new_greeting in the same call. Darwin
        makes the link's id.
      operationId: createPersonalLink
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            Retry safely: the first response is replayed for 24 hours (not for
            streamed answers).
          schema:
            type: string
            maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonalLinkInput'
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonalLink'
        '400':
          description: Invalid request (`invalid_request`, `unsupported_version`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: >-
            Missing or invalid key (`authentication_required`,
            `invalid_api_key`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '402':
          description: >-
            The workspace must add a card before the API can be used
            (`payment_required`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: The key lacks the scope (`insufficient_scope`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: No such object in this workspace (`not_found`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: >-
            Conflicts with the current state (`conflict`,
            `idempotency_key_in_use`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '422':
          description: Refused by a rule (`unprocessable`, `idempotency_key_reused`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: >-
            Rate limited (`rate_limited`) or a monthly allowance used
            (`quota_exceeded`); see Retry-After.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
components:
  schemas:
    PersonalLinkInput:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 60
          description: What your team calls the campaign, e.g. "Q4 outbound".
        page:
          type: string
          minLength: 1
          maxLength: 500
          description: >-
            The page it opens: a path on your website (/pricing) or a full https
            address. The chat must be installed there.
        greeting:
          anyOf:
            - type: string
              pattern: ^gr_[a-z0-9]{4,16}$
            - type: 'null'
          description: >-
            The greeting it shows (gr_…). Null makes it a draft, which greets no
            one.
        new_greeting:
          $ref: '#/components/schemas/LinkGreetingInput'
          description: >-
            Write a new greeting for this link instead of naming one. It is
            saved to your greetings.
      additionalProperties: false
    PersonalLink:
      type: object
      properties:
        id:
          type: string
          pattern: ^lk_
          example: lk_q4x7mz
        object:
          type: string
          const: personal_link
        name:
          type: string
        page:
          type: string
          description: >-
            The page it opens: a path on the workspace's website, or a full
            address.
        greeting:
          description: The greeting it shows (gr_…); null for a draft.
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - active
            - draft
          description: 'draft: no greeting yet, so it greets no one.'
        url:
          example: https://www.acme.example/pricing?dw=lk_q4x7mz
          description: >-
            The page with the link's id. Add a person's details as dw_email,
            dw_first, dw_last, dw_company and dw_title, or ask POST
            /personal_links/{id}/urls to do it. Null for a draft.
          type:
            - string
            - 'null'
        fields:
          type: array
          items:
            type: string
          description: >-
            The details its greeting uses: first_name, last_name, company,
            title.
        templates:
          anyOf:
            - type: object
              propertyNames:
                type: string
              additionalProperties:
                type: string
            - type: 'null'
          description: >-
            The address with each email tool's merge fields (hubspot, instantly,
            apollo, outreach, salesloft, lemlist, other), ready to paste into a
            sequence. Null for a draft.
        results:
          type: object
          properties:
            days:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            visits:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            chats:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            meetings:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
          required:
            - days
            - visits
            - chats
            - meetings
          description: >-
            The last 30 days: people who opened it, how many of them chatted,
            and how many booked. Your team's and test visits are left out.
      required:
        - id
        - object
        - name
        - page
        - greeting
        - status
        - url
        - fields
        - templates
        - results
    Problem:
      type: object
      properties:
        type:
          type: string
          example: https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope
        title:
          type: string
        status:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        code:
          type: string
          example: insufficient_scope
        detail:
          type: string
        param:
          type: string
        request_id:
          type: string
          example: req_8m2k4p0q1x7z9c3v5b6n
      required:
        - type
        - title
        - status
        - code
        - detail
        - request_id
    LinkGreetingInput:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 60
          description: What your team calls it.
        text:
          type: string
          minLength: 1
          maxLength: 200
          description: >-
            What the chat says. Put a person's details in braces with words for
            when the link has none: {first|there}, {company|your team}, {title},
            {last}. A field with no fallback is left out with the space before
            it.
        buttons:
          maxItems: 4
          type: array
          items:
            type: object
            properties:
              label:
                type: string
                minLength: 1
                maxLength: 40
                description: >-
                  What the reply button says. Fields allowed, e.g. "Pricing for
                  {company|your team}".
              message:
                description: What a click sends as the visitor; the label when left out.
                type: string
                maxLength: 200
            required:
              - label
            additionalProperties: false
          description: >-
            Up to four reply buttons. They replace the page's own; an empty list
            keeps the page's.
        agent_note:
          anyOf:
            - type: string
              maxLength: 500
            - type: 'null'
          description: >-
            What the agent should know about people you send this to, e.g. why
            you reached out. Fields allowed. Null or empty removes it.
      additionalProperties: false
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        A secret key (dk_live_…). Scopes: conversations:read, contacts:read,
        contacts:write, meetings:read, analytics:read, events:read,
        webhooks:write, knowledge:read, knowledge:write, agent:read,
        agent:write, experiments:read, experiments:write, privacy:write,
        chat:write.

````

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