> ## Documentation Index
> Fetch the complete documentation index at: https://docs.melso.ai/llms.txt
> Use this file to discover all available pages before exploring further.
> ## Agent Instructions
> Melso product MCP: https://melso.ai/api/mcp (OAuth; one company per grant). REST: https://melso.ai. Documentation-search MCP: https://docs.melso.ai/mcp. The docs search server does not act on customer accounts.
>
> Use the live tool schema and respect company membership. Ask the person to authorize the exact fiscal document version in the signed-in app. A professional prepares and files included returns after authorization; AI does not file alone. A prepared file or approval receipt is not evidence of filing. Never claim completion from an accepted Task or Run. Keep credentials out of chat and logs. Agents features are internal or by private invitation.
# Get run usage
> Authenticated member; company membership and credential scope apply.
## OpenAPI
````yaml /api-reference/openapi.json get /api/runs/{runId}/usage
openapi: 3.1.0
info:
title: Melso API
version: '2026-10-12'
description: >-
Customer integration contracts for Melso. Agents access is internal or by
private invitation. Fiscal approval remains in the authenticated app.
contact:
name: Melso
url: https://melso.ai/en
servers:
- url: https://melso.ai
description: Production API origin
security: []
tags:
- name: Areas
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Areas operations available within the caller's documented permissions.
- name: Artifacts
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Artifacts operations available within the caller's documented permissions.
- name: Authentication
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Authentication operations available within the caller's documented
permissions.
- name: Automations
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Automations operations available within the caller's documented
permissions.
- name: Companies
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Companies operations available within the caller's documented permissions.
- name: Execution funding
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Execution funding operations available within the caller's documented
permissions.
- name: Files
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Files operations available within the caller's documented permissions.
- name: GitHub
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
GitHub operations available within the caller's documented permissions.
- name: Interactions
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Interactions operations available within the caller's documented
permissions.
- name: Knowledge
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Knowledge operations available within the caller's documented permissions.
- name: MCP
description: MCP operations available within the caller's documented permissions.
- name: Messages
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Messages operations available within the caller's documented permissions.
- name: OAuth
description: OAuth operations available within the caller's documented permissions.
- name: Private network
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Private network operations available within the caller's documented
permissions.
- name: Runs
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Runs operations available within the caller's documented permissions.
- name: Skills
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Skills operations available within the caller's documented permissions.
- name: Tasks
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Tasks operations available within the caller's documented permissions.
- name: Vault
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Vault operations available within the caller's documented permissions.
- name: Webhooks
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Webhooks operations available within the caller's documented permissions.
paths:
/api/runs/{runId}/usage:
get:
tags:
- Runs
summary: Get run usage
description: Authenticated member; company membership and credential scope apply.
operationId: getRunUsage
parameters:
- name: runId
in: path
required: true
description: runId from the corresponding authorized response.
schema:
type: string
- name: X-Workspace-ID
in: header
required: false
description: >-
Company UUID for a personal token on company-scoped operations. A
company API key already binds its company.
schema:
type: string
format: uuid
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/runUsageResponse'
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Authentication required.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Credential, company or resource access denied.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Resource unavailable to this caller.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limited; respect Retry-After when present.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
components:
schemas:
runUsageResponse:
type: object
properties:
run_id:
type: string
task_id:
type: string
workspace_id:
type: string
execution_identity_id:
anyOf:
- type: string
- type: 'null'
funding:
$ref: '#/components/schemas/runUsageFunding'
as_of:
type: string
format: date-time
final:
type: boolean
pending_count:
type: integer
customer_billed_ticks:
type: string
reported_model_cost_ticks:
anyOf:
- type: string
- type: 'null'
reported_model_cost_updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
receipts:
type: array
items:
$ref: '#/components/schemas/runUsageReceipt'
usage:
type: array
items:
$ref: '#/components/schemas/runUsageOperation'
required:
- run_id
- task_id
- workspace_id
- funding
- as_of
- final
- pending_count
- customer_billed_ticks
- reported_model_cost_ticks
- reported_model_cost_updated_at
- receipts
- usage
Error:
type: object
properties:
error:
type: string
code:
type: string
required:
- error
additionalProperties: true
runUsageFunding:
type: object
properties:
source:
type: string
account_id:
anyOf:
- type: string
- type: 'null'
required:
- source
runUsageReceipt:
type: object
properties:
receipt_id:
type: string
usage_id:
type: string
category:
type: string
customer_billed_ticks:
type: string
estimated:
type: boolean
settled_at:
type: string
format: date-time
required:
- receipt_id
- usage_id
- category
- customer_billed_ticks
- estimated
- settled_at
runUsageOperation:
type: object
properties:
usage_id:
type: string
category:
type: string
status:
type: string
customer_billed_ticks:
anyOf:
- type: string
- type: 'null'
revision:
type: integer
closed:
type: boolean
required:
- usage_id
- category
- status
- customer_billed_ticks
- revision
- closed
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
Company API key (mwk_) or personal access token (mel_). A PAT requires
X-Workspace-ID on company-scoped routes. An API key implies its own
company.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.