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

# List mission templates

> Ready-made Milian Missions from the template gallery of the web app, in the requested language. To use one, replace every `{placeholder}` in `prompt` (each entry of `inputs` says what one asks for), then create the mission with `createRoutine` using `name`, the filled `prompt` and the `schedule` fields. Templates with `beta: true` run on a platform `event` instead of a schedule: they need Workspace Beta Features and are set up in the app as a Mission Studio draft. `createRoutine` cannot create them, and their `schedule` is `null`. When `read_check` is set, the mission attaches the chosen automations and skips its AI run when none of them failed. The featured template comes first. **Required scope:** `routines:read`.



## OpenAPI

````yaml /api-reference/openapi.json get /mission-templates
openapi: 3.1.0
info:
  title: Famulor API
  version: 1.0.0
  description: >-
    REST API for Famulor. Authenticate with an API key (`fam_...`, created under
    **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`) as a
    Bearer token.


    Every response uses a consistent envelope: `{ "data": ... , "meta": { ... }
    }` on success and `{ "error": { "code", "message" } }` on failure. List
    endpoints paginate with `?limit=` (default 50, max 200) and `?offset=`;
    `meta.pagination.total` carries the total match count.


    REST operations require API Access through the workspace plan or a recurring
    add-on. Without it, regular operations return `403 api_access_required`. The
    invoice-payment and billing-portal operations remain available with a valid
    `billing:write` credential after a failed plan payment so an authorized
    owner, admin, or billing member can recover billing.


    The same customer-facing capabilities are available as MCP tools at
    `https://app.famulor.io/mcp` (Model Context Protocol, streamable HTTP) using
    the same credentials, scopes, and workspace access. MCP availability is
    controlled separately by Connect AI / MCP, not by API Access.
servers:
  - url: https://app.famulor.io/api/v1
    description: Hosted platform.
  - url: https://{domain}/api/v1
    description: White-label tenant domain — same paths, tenant branding.
    variables:
      domain:
        default: app.famulor.io
        description: Your white-label tenant domain.
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Self-inspection of the calling credential.
  - name: Migrations
    description: Preview and import data from supported legacy platforms.
  - name: Assistants
    description: Create and manage voice assistants.
  - name: Tools
    description: >-
      Reusable tools (HTTP APIs, external MCP servers and actions of connected
      apps) assistants can call mid-conversation.
  - name: Voices
    description: Browse the text-to-speech voice library.
  - name: Calls
    description: Start outbound calls and read call history, transcripts and recordings.
  - name: History
    description: Unified conversation history across calls, messaging and assistant emails.
  - name: Campaigns
    description: Outbound calling campaigns with a compliant power dialer.
  - name: Leads
    description: Manage Audience contacts across campaigns, channels and Call QA metrics.
  - name: Segments
    description: >-
      Saved, dynamic lead filters — reusable audience definitions used for
      Audience search and campaign lead assignment.
  - name: Suppression
    description: Cross-channel marketing opt-outs and active workspace suppression records.
  - name: Callbacks
    description: >-
      Scheduled callbacks booked by the Schedule callback tool across voice,
      chat, and email.
  - name: Phone Numbers
    description: Marketplace numbers and customer-provided numbers.
  - name: Famulor Loop
    description: >-
      Personal business-phone access, directory, presence, devices, and Loop
      call recents.
  - name: SIP Trunks
    description: Bring your own SIP provider and numbers.
  - name: Carrier Connections
    description: Connect a supported carrier account and import its existing phone numbers.
  - name: Knowledge Bases
    description: RAG knowledge bases and documents for assistants.
  - name: Settings
    description: Workspace-level settings such as caller-memory defaults.
  - name: Billing
    description: Balance and transaction ledger of the API key's workspace.
  - name: Automations
    description: >-
      Native workspace automations — list, create, update, trigger. Requires
      Automations in the workspace plan.
  - name: Milian Missions
    description: Recurring jobs that Milian runs unattended on schedule.
  - name: Integrations
    description: >-
      Calendar integrations (Cal.com, Calendly, Acuity Scheduling, Google
      Calendar, Outlook, native booking engine). Assign them to assistants to
      provide availability and booking tools, plus provider-supported
      appointment lookup, cancellation, and rescheduling.
  - name: Bookings
    description: >-
      Native booking engine — event types with weekly availability, public
      booking pages at /book/{workspace}/{slug}, and the bookings they produce.
  - name: Dashboards
    description: >-
      Custom analytics dashboards, reusable widgets, and tenant-scoped
      performance analytics. Requires Custom dashboards in the workspace plan.
  - name: Catalog
    description: >-
      Read-only platform catalogs — available models, supported assistant
      languages, and prompt templates.
  - name: Simulations
    description: Assistant simulation tests (plan-gated).
  - name: Versions
    description: Assistant configuration version history.
  - name: Caller IDs
    description: Outbound caller ID verification.
  - name: Widgets
    description: Web widget connectors.
  - name: Messaging
    description: >-
      Telegram, Slack, and Messenger text bots linked to assistants (Chat SDK).
      Includes conversation delay, inactivity end, and conversation-ended
      webhooks.
  - name: QA
    description: Cohort AI Quality Assurance runs over call transcripts.
  - name: White Label
    description: >-
      Manage white-label customer accounts, defaults, credit transfers and
      customer plan offers. Each endpoint documents its required scope and
      workspace eligibility.
  - name: API Keys
    description: >-
      Self-service API keys for the calling workspace or a same-brand workspace
      where the credential's user is owner/admin. A key can only mint further
      keys with a scope subset of its own.
  - name: Workspaces
    description: >-
      List visible workspaces, create an additional workspace for the key owner,
      and mint a dedicated credential for a selected owner/admin workspace.
  - name: SMS
    description: Outbound SMS from workspace phone numbers.
  - name: Milian
    description: >-
      Ask Milian, the AI co-worker in your workspace, and start voice sessions
      with it.
  - name: Translation
    description: >-
      Live translation sessions that interpret a conversation between two
      languages.
  - name: Shopify
    description: Native Shopify app store connections, assistant tools and activity.
  - name: Avatars
    description: Private custom avatars and widget avatar selection.
  - name: Webhook Subscriptions
    description: >-
      Signed workspace event subscriptions, independent of existing
      destinations.
paths:
  /mission-templates:
    get:
      tags:
        - Milian Missions
      summary: List mission templates
      description: >-
        Ready-made Milian Missions from the template gallery of the web app, in
        the requested language. To use one, replace every `{placeholder}` in
        `prompt` (each entry of `inputs` says what one asks for), then create
        the mission with `createRoutine` using `name`, the filled `prompt` and
        the `schedule` fields. Templates with `beta: true` run on a platform
        `event` instead of a schedule: they need Workspace Beta Features and are
        set up in the app as a Mission Studio draft. `createRoutine` cannot
        create them, and their `schedule` is `null`. When `read_check` is set,
        the mission attaches the chosen automations and skips its AI run when
        none of them failed. The featured template comes first. **Required
        scope:** `routines:read`.
      operationId: listMissionTemplates
      parameters:
        - name: language
          in: query
          required: false
          schema:
            type: string
            enum:
              - en
              - de
              - fr
              - es
            default: en
          description: >-
            Language of the names, descriptions, input questions and prompts.
            The server answers in English for any other value.
        - name: category
          in: query
          required: false
          schema:
            type: string
            enum:
              - improve
              - monitor
              - reports
              - customers
          description: Only templates of this category.
      responses:
        '200':
          description: Mission templates.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/MissionTemplate'
              example:
                data:
                  - id: self_improving_assistant
                    category: improve
                    name: Assistant improves itself
                    description: >-
                      Reads yesterday's conversations every morning, finds gaps
                      and fixes them.
                    featured: true
                    beta: false
                    schedule:
                      schedule_type: daily
                      schedule_time: '07:00'
                      schedule_weekday: null
                    event: null
                    capabilities:
                      - read
                      - write
                      - communicate
                    inputs:
                      - id: assistant
                        question: Which assistant?
                      - id: mode
                        question: Fix it yourself or only suggest?
                      - id: report_to
                        question: Where should the report go?
                    read_check: null
                    prompt: >-
                      Review yesterday's calls and chats of the assistant
                      {assistant}, including their evaluations. Find what went
                      wrong: questions it could not answer, wrong or missing
                      information, conversations that ended early or were rated
                      badly. Mode: {mode}. In "fix" mode, add the missing
                      answers to the assistant's knowledge base and sharpen its
                      prompt where the prompt caused the problem; save every
                      change so it can be restored as a version. In "suggest"
                      mode, change nothing. Then send {report_to} a short
                      report: what you found, what you changed or suggest, with
                      links to the conversations. If nothing needs fixing, say
                      so in one line.
                  - id: dropped_calls_followup
                    category: customers
                    name: Follow up dropped calls
                    description: >-
                      Sends an SMS when a call ends before the request was
                      handled.
                    featured: false
                    beta: true
                    schedule: null
                    event: call.completed
                    capabilities:
                      - read
                      - communicate
                    inputs:
                      - id: sms_number
                        question: Which number sends the SMS?
                    read_check: null
                    prompt: >-
                      A call just ended. If the caller hung up before their
                      request was handled, send them one SMS from {sms_number}:
                      thank them for calling and offer a callback. Do nothing
                      for calls that ended normally, for outbound calls and for
                      numbers that opted out.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/RequestProtectionUnavailable'
components:
  schemas:
    MissionTemplate:
      type: object
      description: A ready-made Milian Mission from the template gallery.
      required:
        - id
        - category
        - name
        - description
        - featured
        - beta
        - schedule
        - event
        - capabilities
        - inputs
        - read_check
        - prompt
      properties:
        id:
          type: string
          description: Stable template id.
          example: self_improving_assistant
        category:
          type: string
          enum:
            - improve
            - monitor
            - reports
            - customers
        name:
          type: string
          description: >-
            Template name in the requested language. Send it as `name` to
            `createRoutine`.
          example: Assistant improves itself
        description:
          type: string
          description: What the mission does, in the requested language.
        featured:
          type: boolean
          description: Shown first in the gallery.
        beta:
          type: boolean
          description: >-
            `true` when the template runs on a platform `event` instead of a
            schedule. It needs Workspace Beta Features and is set up in the app
            as a Mission Studio draft; `createRoutine` cannot create it.
        schedule:
          type:
            - object
            - 'null'
          description: >-
            The schedule fields for `createRoutine`; `null` for `beta`
            templates.
          required:
            - schedule_type
            - schedule_time
            - schedule_weekday
          properties:
            schedule_type:
              type: string
              enum:
                - hourly
                - daily
                - weekdays
                - weekly
            schedule_time:
              type:
                - string
                - 'null'
              description: 24h wall-clock time "HH:MM"; `null` for `hourly`.
              example: '07:00'
            schedule_weekday:
              type:
                - integer
                - 'null'
              minimum: 0
              maximum: 6
              description: >-
                weekly only — day of week, 0=Sunday … 6=Saturday; otherwise
                `null`.
        event:
          type:
            - string
            - 'null'
          enum:
            - call.completed
            - lead.created
            - null
          description: >-
            The platform event a `beta` template runs on; `null` for scheduled
            templates.
        capabilities:
          type: array
          items:
            type: string
            enum:
              - read
              - write
              - communicate
              - call
          description: >-
            What the mission needs to do its work: read data, change data
            (`write`), send messages (`communicate`) or place calls (`call`).
          example:
            - read
            - write
            - communicate
        inputs:
          type: array
          description: >-
            Every `{placeholder}` in `prompt`, with the question to answer
            before you create the mission. `id` is the placeholder name without
            the braces.
          items:
            type: object
            required:
              - id
              - question
            properties:
              id:
                type: string
                example: assistant
              question:
                type: string
                description: The question in the requested language.
                example: Which assistant?
        read_check:
          type:
            - string
            - 'null'
          enum:
            - automation_failures
            - null
          description: >-
            `automation_failures`: the mission attaches the chosen automations
            and skips its AI run when none of them failed (`readCheck` of a
            mission version). `null` when every run uses the AI.
        prompt:
          type: string
          description: >-
            The instructions every run follows, in the requested language.
            Replace every `{placeholder}` listed in `inputs` before you send it
            as `prompt` to `createRoutine`.
    ErrorEnvelope:
      type: object
      description: Error envelope returned by every /api/v1 endpoint on failure.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - unauthorized
                - forbidden
                - api_access_required
                - not_found
                - invalid_request
                - rate_limited
                - conflict
                - telephony_configuration_error
                - telephony_unavailable
                - destination_forbidden
                - internal_error
                - service_unavailable
                - verification_address_required
                - bundle_address_missing
              description: >-
                Stable, machine-readable error code. `service_unavailable` is
                returned by POST /bookings and GET
                /booking-event-types/{id}/slots specifically when the
                availability engine could not be reached (see
                AvailabilityOrProtectionUnavailable).
                `verification_address_required` and `bundle_address_missing` are
                returned by POST /phone-numbers when the verification behind the
                number has no address (see the operation description).
            message:
              type: string
              description: Human-readable description of the error.
            reason:
              type: string
              description: >-
                Optional, more specific and stable reason for this error, for
                example `plan_required`, `read_only_role` or `missing_scope`.
                Branch on `code` first: `reason` is only present on some errors,
                and new values may be added. Campaign operations use
                `attestation_required` (400, `compliance_attestation` missing on
                launch), `launch_required` (400, a sequence campaign was never
                launched; launch it or start it with `compliance_attestation`),
                `sequence_changed` (409, the sequence changed after
                `sequence_hash` was taken), `campaign_sequences_unavailable`
                (403, the plan does not include Campaign sequences),
                `campaign_extension_unavailable` (503 `service_unavailable`, the
                campaign feature is not available yet) and `analytics_timeout`
                (504 `service_unavailable`, the campaign analytics took too
                long; choose a shorter period).
            hint:
              type: string
              description: >-
                Optional recovery advice that is safe to show to the end user,
                for example which settings page to open.
  responses:
    BadRequest:
      description: Invalid request body or parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: invalid_request
              message: '"to_number" is required (E.164 format, e.g. +4930123456).'
    Unauthorized:
      description: Missing, invalid, expired or revoked API key / access token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: unauthorized
              message: Invalid API key.
    Forbidden:
      description: >-
        The credential lacks the required scope or role, or the workspace does
        not have the required capability.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            scopeDenied:
              summary: Required scope is missing
              value:
                error:
                  code: forbidden
                  message: >-
                    This API key is missing the required scope
                    "assistants:write".
            apiAccessRequired:
              summary: API Access is not available
              value:
                error:
                  code: api_access_required
                  message: >-
                    API Access is not available for this workspace. Review
                    Settings → Plan.
    RateLimited:
      description: Too many requests. Retry after the indicated delay.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
            minimum: 1
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: rate_limited
              message: Too many requests. Retry after the indicated delay.
    RequestProtectionUnavailable:
      description: Request protection is temporarily unavailable.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
            minimum: 1
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: internal_error
              message: Request protection is temporarily unavailable.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        API key (`fam_...`, created under **Settings → API Keys**) or an OAuth
        2.0 access token (`fam_at_...`). REST operations also require API Access
        for the credential's workspace. Keys can be restricted to scopes such as
        `assistants:read`, `calls:write`, `campaigns:write`, `automations:read`,
        `dashboards:read`, `dashboards:write`, `leads:write`, `segments:write`,
        `loop:read`, `loop:write`, `phone_numbers:write`, `sip_trunks:write`,
        `knowledge:write`, `voices:read`, `billing:read`, `billing:write`,
        `settings:write`, `platform:read`, `platform:write`; a `*:write` scope
        implies the matching `*:read`. Automation and dashboard endpoints also
        accept the legacy `calls:*` scope. Keys without scope restrictions have
        full access within the workspace's available capabilities.

````

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