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

# Install an integration

> Server-side sibling of the browser consent flow at `POST /integrations/:id/install`. Skips the HTML consent screen — admin-only — so operators and tooling can install connections non-interactively. Body carries `integration_id`, an optional `label`, an optional `credential_ref`, and an optional `configuration` bag that seeds the new connection's `properties.configuration` (e.g. `upstream_base_url_override` for per-host upstream targeting). Returns the connection id, the seed runtime credential id, and the system.activity row id from the install pipeline. Same compensating-write pipeline as the HTML path; same audit trail.



## OpenAPI

````yaml /openapi.json post /connections/install
openapi: 3.1.0
info:
  title: Marfa API
  version: 4.2.0
  description: Typed data layer for structured personal data
servers: []
security: []
paths:
  /connections/install:
    post:
      tags:
        - Connections
      summary: Install an integration
      description: >-
        Server-side sibling of the browser consent flow at `POST
        /integrations/:id/install`. Skips the HTML consent screen — admin-only —
        so operators and tooling can install connections non-interactively. Body
        carries `integration_id`, an optional `label`, an optional
        `credential_ref`, and an optional `configuration` bag that seeds the new
        connection's `properties.configuration` (e.g.
        `upstream_base_url_override` for per-host upstream targeting). Returns
        the connection id, the seed runtime credential id, and the
        system.activity row id from the install pipeline. Same
        compensating-write pipeline as the HTML path; same audit trail.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                integration_id:
                  type: string
                label:
                  type: string
                credential_ref:
                  type: string
                configuration:
                  type: object
                  additionalProperties:
                    nullable: true
              required:
                - integration_id
      responses:
        '201':
          description: >-
            Connection installed. Returns the new connection id, seed credential
            id, and activity id.
          content:
            application/json:
              schema:
                type: object
                properties:
                  connection_id:
                    type: string
                  credential_id:
                    type: string
                  activity_id:
                    type: string
                required:
                  - connection_id
                  - credential_id
                  - activity_id
        '400':
          description: >-
            integration_id does not refer to a system.integration item, or the
            manifest is invalid.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - validation_error
                          - missing_required_field
                      message:
                        type: string
                      details:
                        type: object
                        additionalProperties:
                          nullable: true
                    required:
                      - code
                      - message
                required:
                  - error
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - unauthorized
                      message:
                        type: string
                      details:
                        type: object
                        additionalProperties:
                          nullable: true
                    required:
                      - code
                      - message
                required:
                  - error
        '403':
          description: Caller is not an admin.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - forbidden
                      message:
                        type: string
                      details:
                        type: object
                        additionalProperties:
                          nullable: true
                    required:
                      - code
                      - message
                required:
                  - error
        '404':
          description: >-
            Integration not found. Matches both genuinely-missing manifest ids
            and ids that exist but resolve to a non-`system.integration` item.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - integration_not_found
                      message:
                        type: string
                      details:
                        type: object
                        additionalProperties:
                          nullable: true
                    required:
                      - code
                      - message
                required:
                  - error
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key or OAuth Token
      description: Pass an API key (marfa_k1_...) or OAuth access token (marfa_at_...)

````