Koyeb Rest API — Usages

naftiko: 1.0.0-alpha2
info:
  label: Koyeb Rest API — Usages
  description: 'Koyeb Rest API — Usages. 2 operations. Lead operation: Get organization usage. Self-contained Naftiko capability
    covering one Koyeb business surface.'
  tags:
  - Koyeb
  - Usages
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    KOYEB_API_KEY: KOYEB_API_KEY
capability:
  consumes:
  - type: http
    namespace: koyeb-usages
    baseUri: https://app.koyeb.com
    description: Koyeb Rest API — Usages business capability. Self-contained, no shared references.
    resources:
    - name: v1-usages
      path: /v1/usages
      operations:
      - name: getorganizationusage
        method: GET
        description: Get organization usage
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: starting_time
          in: query
          type: string
          description: The starting time of the period to get data from
        - name: ending_time
          in: query
          type: string
          description: The ending time of the period to get data from
    - name: v1-usages-details
      path: /v1/usages/details
      operations:
      - name: getorganizationusagedetails
        method: GET
        description: Get organization usage details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: starting_time
          in: query
          type: string
          description: The starting time of the period to get data from
        - name: ending_time
          in: query
          type: string
          description: The ending time of the period to get data from
        - name: limit
          in: query
          type: string
          description: (Optional) The number of items to return
        - name: offset
          in: query
          type: string
          description: (Optional) The offset in the list of item to return
        - name: order
          in: query
          type: string
          description: (Optional) Sorts the list in the ascending or the descending order
        - name: Accept
          in: header
          type: string
          description: If defined with the value 'text/csv', a csv file is returned
  exposes:
  - type: rest
    namespace: koyeb-usages-rest
    port: 8080
    description: REST adapter for Koyeb Rest API — Usages. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/usages
      name: v1-usages
      description: REST surface for v1-usages.
      operations:
      - method: GET
        name: getorganizationusage
        description: Get organization usage
        call: koyeb-usages.getorganizationusage
        with:
          starting_time: rest.starting_time
          ending_time: rest.ending_time
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/usages/details
      name: v1-usages-details
      description: REST surface for v1-usages-details.
      operations:
      - method: GET
        name: getorganizationusagedetails
        description: Get organization usage details
        call: koyeb-usages.getorganizationusagedetails
        with:
          starting_time: rest.starting_time
          ending_time: rest.ending_time
          limit: rest.limit
          offset: rest.offset
          order: rest.order
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: koyeb-usages-mcp
    port: 9090
    transport: http
    description: MCP adapter for Koyeb Rest API — Usages. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-organization-usage
      description: Get organization usage
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: koyeb-usages.getorganizationusage
      with:
        starting_time: tools.starting_time
        ending_time: tools.ending_time
      outputParameters:
      - type: object
        mapping: $.
    - name: get-organization-usage-details
      description: Get organization usage details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: koyeb-usages.getorganizationusagedetails
      with:
        starting_time: tools.starting_time
        ending_time: tools.ending_time
        limit: tools.limit
        offset: tools.offset
        order: tools.order
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.