> ## 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.

# The agent's settings

> Requires the `agent:read` scope.



## OpenAPI

````yaml /api-reference/openapi.json get /agent
openapi: 3.1.0
info:
  title: Darwin API
  version: '2026-10-12'
  description: >-
    Read and act on your Darwin workspace: conversations, contacts, meetings,
    analytics, knowledge, the agent 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: Analytics
  - name: Events
  - name: Webhooks
  - name: Knowledge
  - name: Agent
  - name: Experiments
  - name: Privacy
  - name: Chat
paths:
  /agent:
    get:
      tags:
        - Agent
      summary: The agent's settings
      description: Requires the `agent:read` scope.
      operationId: getAgent
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Agent'
        '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:
    Agent:
      type: object
      properties:
        object:
          type: string
          const: agent
        name:
          type: string
        role:
          type: string
        tone:
          type: string
        greeting:
          type: string
        intro:
          type: string
        suggestions:
          type: array
          items:
            type: string
        booking_link:
          type:
            - string
            - 'null'
        business_context:
          type: string
        allowed_origins:
          type: array
          items:
            type: string
        opening:
          type: object
          properties:
            enabled:
              type: boolean
            headline:
              type: string
            buttons:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  message:
                    type: string
                  locked:
                    type: boolean
                required:
                  - label
                  - message
                  - locked
            excluded_paths:
              type: array
              items:
                type: string
          required:
            - enabled
            - headline
            - buttons
            - excluded_paths
        automation:
          type: object
          properties:
            auto_testing:
              type: boolean
            auto_launch:
              type: boolean
            auto_promote:
              type: boolean
          required:
            - auto_testing
            - auto_launch
            - auto_promote
        live:
          type: boolean
        site_key:
          type: string
        embed_snippet:
          type: string
      required:
        - object
        - name
        - role
        - tone
        - greeting
        - intro
        - suggestions
        - booking_link
        - business_context
        - allowed_origins
        - opening
        - automation
        - live
        - site_key
        - embed_snippet
    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
  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.