Ampersand public API — API Key

naftiko: 1.0.0-alpha2
info:
  label: Ampersand public API — API Key
  description: 'Ampersand public API — API Key. 5 operations. Lead operation: Ampersand List API Keys. Self-contained Naftiko
    capability covering one Ampersand business surface.'
  tags:
  - Ampersand
  - API Key
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    AMPERSAND_API_KEY: AMPERSAND_API_KEY
capability:
  consumes:
  - type: http
    namespace: ampersand-api-key
    baseUri: https://api.withampersand.com/v1
    description: Ampersand public API — API Key business capability. Self-contained, no shared references.
    resources:
    - name: projects-projectIdOrName-api-keys
      path: /projects/{projectIdOrName}/api-keys
      operations:
      - name: listapikeys
        method: GET
        description: Ampersand List API Keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectIdOrName
          in: path
          type: string
          description: The Ampersand project ID or project name.
          required: true
        - name: active
          in: query
          type: boolean
          description: Whether to include only active API keys. If false, all API keys are included.
      - name: createapikey
        method: POST
        description: Ampersand Create a New API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectIdOrName
          in: path
          type: string
          description: The Ampersand project ID or project name.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: projects-projectIdOrName-api-keys-apiKey
      path: /projects/{projectIdOrName}/api-keys/{apiKey}
      operations:
      - name: getapikey
        method: GET
        description: Ampersand Get an API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectIdOrName
          in: path
          type: string
          description: The Ampersand project ID or project name.
          required: true
        - name: apiKey
          in: path
          type: string
          description: API key to access Ampersand APIs.
          required: true
      - name: deleteapikey
        method: DELETE
        description: Ampersand Delete an API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectIdOrName
          in: path
          type: string
          description: The Ampersand project ID or project name.
          required: true
        - name: apiKey
          in: path
          type: string
          description: API key to access Ampersand APIs.
          required: true
      - name: updateapikey
        method: PATCH
        description: Ampersand Update an API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectIdOrName
          in: path
          type: string
          description: The Ampersand project ID or project name.
          required: true
        - name: apiKey
          in: path
          type: string
          description: API key to access Ampersand APIs.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.AMPERSAND_API_KEY}}'
  exposes:
  - type: rest
    namespace: ampersand-api-key-rest
    port: 8080
    description: REST adapter for Ampersand public API — API Key. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/projects/{projectidorname}/api-keys
      name: projects-projectidorname-api-keys
      description: REST surface for projects-projectIdOrName-api-keys.
      operations:
      - method: GET
        name: listapikeys
        description: Ampersand List API Keys
        call: ampersand-api-key.listapikeys
        with:
          projectIdOrName: rest.projectIdOrName
          active: rest.active
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createapikey
        description: Ampersand Create a New API Key
        call: ampersand-api-key.createapikey
        with:
          projectIdOrName: rest.projectIdOrName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectidorname}/api-keys/{apikey}
      name: projects-projectidorname-api-keys-apikey
      description: REST surface for projects-projectIdOrName-api-keys-apiKey.
      operations:
      - method: GET
        name: getapikey
        description: Ampersand Get an API Key
        call: ampersand-api-key.getapikey
        with:
          projectIdOrName: rest.projectIdOrName
          apiKey: rest.apiKey
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteapikey
        description: Ampersand Delete an API Key
        call: ampersand-api-key.deleteapikey
        with:
          projectIdOrName: rest.projectIdOrName
          apiKey: rest.apiKey
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateapikey
        description: Ampersand Update an API Key
        call: ampersand-api-key.updateapikey
        with:
          projectIdOrName: rest.projectIdOrName
          apiKey: rest.apiKey
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ampersand-api-key-mcp
    port: 9090
    transport: http
    description: MCP adapter for Ampersand public API — API Key. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: ampersand-list-api-keys
      description: Ampersand List API Keys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ampersand-api-key.listapikeys
      with:
        projectIdOrName: tools.projectIdOrName
        active: tools.active
      outputParameters:
      - type: object
        mapping: $.
    - name: ampersand-create-new-api-key
      description: Ampersand Create a New API Key
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ampersand-api-key.createapikey
      with:
        projectIdOrName: tools.projectIdOrName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ampersand-get-api-key
      description: Ampersand Get an API Key
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ampersand-api-key.getapikey
      with:
        projectIdOrName: tools.projectIdOrName
        apiKey: tools.apiKey
      outputParameters:
      - type: object
        mapping: $.
    - name: ampersand-delete-api-key
      description: Ampersand Delete an API Key
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ampersand-api-key.deleteapikey
      with:
        projectIdOrName: tools.projectIdOrName
        apiKey: tools.apiKey
      outputParameters:
      - type: object
        mapping: $.
    - name: ampersand-update-api-key
      description: Ampersand Update an API Key
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ampersand-api-key.updateapikey
      with:
        projectIdOrName: tools.projectIdOrName
        apiKey: tools.apiKey
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.