Firecrawl API — Billing

naftiko: 1.0.0-alpha2
info:
  label: Firecrawl API — Billing
  description: 'Firecrawl API — Billing. 4 operations. Lead operation: Get remaining credits for the authenticated team. Self-contained
    Naftiko capability covering one Firecrawl business surface.'
  tags:
  - Firecrawl
  - Billing
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FIRECRAWL_API_KEY: FIRECRAWL_API_KEY
capability:
  consumes:
  - type: http
    namespace: firecrawl-billing
    baseUri: https://api.firecrawl.dev/v2
    description: Firecrawl API — Billing business capability. Self-contained, no shared references.
    resources:
    - name: team-credit-usage
      path: /team/credit-usage
      operations:
      - name: getcreditusage
        method: GET
        description: Get remaining credits for the authenticated team
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: team-credit-usage-historical
      path: /team/credit-usage/historical
      operations:
      - name: gethistoricalcreditusage
        method: GET
        description: Get historical credit usage for the authenticated team
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: byApiKey
          in: query
          type: boolean
          description: Get historical credit usage by API key
    - name: team-token-usage
      path: /team/token-usage
      operations:
      - name: gettokenusage
        method: GET
        description: Get remaining tokens for the authenticated team (Extract only)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: team-token-usage-historical
      path: /team/token-usage/historical
      operations:
      - name: gethistoricaltokenusage
        method: GET
        description: Get historical token usage for the authenticated team (Extract only)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: byApiKey
          in: query
          type: boolean
          description: Get historical token usage by API key
    authentication:
      type: bearer
      token: '{{env.FIRECRAWL_API_KEY}}'
  exposes:
  - type: rest
    namespace: firecrawl-billing-rest
    port: 8080
    description: REST adapter for Firecrawl API — Billing. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/team/credit-usage
      name: team-credit-usage
      description: REST surface for team-credit-usage.
      operations:
      - method: GET
        name: getcreditusage
        description: Get remaining credits for the authenticated team
        call: firecrawl-billing.getcreditusage
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/team/credit-usage/historical
      name: team-credit-usage-historical
      description: REST surface for team-credit-usage-historical.
      operations:
      - method: GET
        name: gethistoricalcreditusage
        description: Get historical credit usage for the authenticated team
        call: firecrawl-billing.gethistoricalcreditusage
        with:
          byApiKey: rest.byApiKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/team/token-usage
      name: team-token-usage
      description: REST surface for team-token-usage.
      operations:
      - method: GET
        name: gettokenusage
        description: Get remaining tokens for the authenticated team (Extract only)
        call: firecrawl-billing.gettokenusage
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/team/token-usage/historical
      name: team-token-usage-historical
      description: REST surface for team-token-usage-historical.
      operations:
      - method: GET
        name: gethistoricaltokenusage
        description: Get historical token usage for the authenticated team (Extract only)
        call: firecrawl-billing.gethistoricaltokenusage
        with:
          byApiKey: rest.byApiKey
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: firecrawl-billing-mcp
    port: 9090
    transport: http
    description: MCP adapter for Firecrawl API — Billing. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-remaining-credits-authenticated-team
      description: Get remaining credits for the authenticated team
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: firecrawl-billing.getcreditusage
      outputParameters:
      - type: object
        mapping: $.
    - name: get-historical-credit-usage-authenticated
      description: Get historical credit usage for the authenticated team
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: firecrawl-billing.gethistoricalcreditusage
      with:
        byApiKey: tools.byApiKey
      outputParameters:
      - type: object
        mapping: $.
    - name: get-remaining-tokens-authenticated-team
      description: Get remaining tokens for the authenticated team (Extract only)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: firecrawl-billing.gettokenusage
      outputParameters:
      - type: object
        mapping: $.
    - name: get-historical-token-usage-authenticated
      description: Get historical token usage for the authenticated team (Extract only)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: firecrawl-billing.gethistoricaltokenusage
      with:
        byApiKey: tools.byApiKey
      outputParameters:
      - type: object
        mapping: $.