Flowra Usage API
Credit balance and usage ledger for the project API key
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/flowra-dev:flowra-dev-usage-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Flowra API (API Key Endpoints) Usage API
description: '**Flowra** is an AI-powered platform for building agents, workflows, and integrations.
### Capabilities
- **Tools & Toolkits** – Define and group tools for agents and workflows.
- **Workflows** – Orchestrate steps and automate processes.
- **Triggers** – Schedule or event-based execution.
- **Auth & Connections** – OAuth, API keys, and connected accounts.
- **MCP** – Model Context Protocol server integration.
- **Knowledge / RAG** – Add files and URLs for retrieval-augmented generation.
### Authentication
Use the **x-api-key** header with a project API key to access endpoints that support API Key auth. Create and manage API keys in the dashboard under your project settings.
Only endpoints that support API Key authentication via the @ApiKeyEnabled() decorator.
Send x-api-key (required). On multi-tenant endpoints, optionally send x-username to act as an external user.'
version: '1.0'
contact:
name: Flowra
url: https://flowra.dev
servers:
- url: https://flowra.dev
description: Flowra API
tags:
- name: Usage
description: Credit balance and usage ledger for the project API key
paths:
/api/v1/usage:
get:
operationId: UsageController_list
x-apiKeyEnabled: true
summary: Credit usage ledger (API key)
description: Paginated credit usage for the authenticated project. Filter by workflow, execution, thread, or external user.
parameters:
- name: projectId
required: false
in: query
description: 'Project filter (user: own projects only; admin: any project)'
schema:
type: string
- name: page
required: false
in: query
description: Page number
schema:
minimum: 1
default: 1
example: 1
type: number
- name: limit
required: false
in: query
description: Items per page
schema:
minimum: 1
maximum: 100
default: 20
example: 20
type: number
- name: from
required: false
in: query
description: Start date (ISO 8601)
schema:
example: '2026-08-01T00:00:00.000Z'
type: string
- name: to
required: false
in: query
description: End date (ISO 8601)
schema:
example: '2026-09-01T00:00:00.000Z'
type: string
- name: workflowId
required: false
in: query
description: Filter by workflow (agent) ID
schema:
format: uuid
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
type: string
- name: executionId
required: false
in: query
description: Filter by workflow execution log ID
schema:
format: uuid
example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
type: string
- name: eUID
required: false
in: query
description: External user id
schema:
format: uuid
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
type: string
- name: threadId
required: false
in: query
description: LangGraph thread id (via execution logs)
schema:
example: b737d8af-a9e0-4251-9714-3fdc1126e5fb
type: string
- name: type
required: false
in: query
description: Usage type (ai_model, tool, sandbox, …)
schema:
example: tool
enum:
- ai_model
- tool
- sandbox
- browser
- workflow
- media
- connected_account
type: string
responses:
'200':
description: Credit usage retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/CreditUsageResponseDtoSuccessResponse'
example:
success: true
message: Operation completed successfully
data:
items:
- id: ''
userId: ''
projectId: ''
workflowId: ''
executionId: ''
eUID: ''
externalUserName: ''
type: ai_model
creditAmount: 0
delta: 0
entryType: debit
usdCost: 0
platformCostUsd: 0
metadata: {}
createdAt: ''
total: 0
summary:
byType:
ai_model: 0
tool: 0
sandbox: 0
browser: 0
workflow: 0
media: 0
connected_account: 0
total: 0
count: 0
tags:
- Usage
security:
- x-api-key: []
/api/v1/usage/balance:
get:
operationId: UsageController_balance
x-apiKeyEnabled: true
summary: Credit balance (API key)
description: Current credit balance for the account tied to the API key.
responses:
'200':
description: Credit balance retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/CreditBalanceResponseDtoSuccessResponse'
example:
success: true
message: Operation completed successfully
data:
balance: 0
currency: credits
tags:
- Usage
security:
- x-api-key: []
/api/v1/usage/executions/{executionId}:
get:
operationId: UsageController_executionUsage
x-apiKeyEnabled: true
summary: Usage for one execution
description: Net credits and breakdown for a single workflow_execution_logs row.
parameters:
- name: executionId
required: true
in: path
schema:
type: string
responses:
'200':
description: Execution usage retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ExecutionUsageDtoSuccessResponse'
example:
success: true
message: Operation completed successfully
data:
credits: 0
usdCost: 0
breakdown:
ai_model: 0
tool: 0
sandbox: 0
browser: 0
workflow: 0
media: 0
tags:
- Usage
security:
- x-api-key: []
components:
schemas:
CreditBalanceResponseDtoSuccessResponse:
type: object
properties:
success:
type: boolean
description: Success status
example: true
message:
type: string
description: Success message
example: Operation completed successfully
data:
type: object
properties:
balance:
type: number
currency:
type: string
example: credits
required:
- balance
- currency
example:
balance: 0
currency: credits
required:
- success
- message
- data
CreditUsageResponseDtoSuccessResponse:
type: object
properties:
success:
type: boolean
description: Success status
example: true
message:
type: string
description: Success message
example: Operation completed successfully
data:
type: object
properties:
items:
type: array
items:
type: object
properties:
id:
type: string
userId:
type: string
projectId:
type:
- string
- 'null'
workflowId:
type:
- string
- 'null'
executionId:
type:
- string
- 'null'
description: Workflow execution log id when attributed
eUID:
type:
- string
- 'null'
description: External user id when attributed
externalUserName:
type:
- string
- 'null'
description: External user name (usage/me only)
type:
type: string
enum:
- ai_model
- tool
- sandbox
- browser
- workflow
- media
- connected_account
creditAmount:
type: number
delta:
type: number
description: 'Signed wallet change: negative when taken, positive when returned'
entryType:
type: string
enum:
- debit
- credit
usdCost:
type:
- number
- 'null'
description: Amount charged to the user (USD)
platformCostUsd:
type:
- number
- 'null'
description: Actual platform cost (USD; AI usage only)
metadata:
type:
- object
- 'null'
createdAt:
type: string
required:
- id
- userId
- projectId
- workflowId
- executionId
- eUID
- type
- creditAmount
- delta
- entryType
- usdCost
- platformCostUsd
- metadata
- createdAt
total:
type: number
summary:
type: object
properties:
byType:
type: object
properties:
ai_model:
type: number
tool:
type: number
sandbox:
type: number
browser:
type: number
workflow:
type: number
media:
type: number
connected_account:
type: number
total:
type: number
count:
type: number
required:
- byType
- total
- count
required:
- items
- total
- summary
example:
items:
- id: ''
userId: ''
projectId: ''
workflowId: ''
executionId: ''
eUID: ''
externalUserName: ''
type: ai_model
creditAmount: 0
delta: 0
entryType: debit
usdCost: 0
platformCostUsd: 0
metadata: {}
createdAt: ''
total: 0
summary:
byType:
ai_model: 0
tool: 0
sandbox: 0
browser: 0
workflow: 0
media: 0
connected_account: 0
total: 0
count: 0
required:
- success
- message
- data
ExecutionUsageDtoSuccessResponse:
type: object
properties:
success:
type: boolean
description: Success status
example: true
message:
type: string
description: Success message
example: Operation completed successfully
data:
type: object
properties:
credits:
type: number
description: Net credits consumed for this execution/run
usdCost:
type:
- number
- 'null'
description: USD charged to the account for this usage
breakdown:
type: object
properties:
ai_model:
type: number
default: 0
tool:
type: number
default: 0
sandbox:
type: number
default: 0
browser:
type: number
default: 0
workflow:
type: number
default: 0
media:
type: number
default: 0
required:
- ai_model
- tool
- sandbox
- browser
- workflow
- media
required:
- credits
- usdCost
- breakdown
example:
credits: 0
usdCost: 0
breakdown:
ai_model: 0
tool: 0
sandbox: 0
browser: 0
workflow: 0
media: 0
required:
- success
- message
- data
securitySchemes:
x-api-key:
type: apiKey
in: header
name: x-api-key
description: 'Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key: <your-key>'
x-username:
type: apiKey
in: header
name: x-username
description: 'Optional. External user username. If omitted, Flowra uses the project’s default external user. Send as header: x-username: <username>'