Skip to content

feat: Better describe the circumstances under which run usage info is included in API responses #2179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
janbuchar wants to merge 5 commits into
base: master
Choose a base branch
from
Open

feat: Better describe the circumstances under which run usage info is included in API responses #2179

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2545152
Simplify nullable fields
janbuchar Jan 14, 2026
e549938
feat: Better describe the circumstances under which run usage infor i…
janbuchar Jan 14, 2026
d92e3f1
Update apify-api/openapi/components/schemas/actor-runs/Run.yaml
janbuchar Jan 14, 2026
c2af22a
Update apify-api/openapi/components/schemas/actor-runs/Run.yaml
janbuchar Jan 14, 2026
9fb19a2
Update apify-api/openapi/components/schemas/actor-runs/Run.yaml
janbuchar Jan 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions apify-api/openapi/components/schemas/actor-runs/Run.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,18 +93,21 @@ properties:
nullable: true
example: master
usage:
allOf:
- oneOf:
- nullable: true
- $ref: ./RunUsage.yaml
- {}
nullable: true
$ref: ./RunUsage.yaml
usageTotalUsd:
type: number
nullable: true
description: >-
Total cost in USD for this run. Represents what you actually pay.
For run owners: includes platform usage (compute units) and/or event costs depending on the Actor's pricing model.
Copy link
Contributor

@stetizu1 stetizu1 Jan 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

depends on pricing model - yes - but also depends on "if you own the Actor" 😅

Copy link
Contributor Author

@janbuchar janbuchar Jan 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean, this is written under "For run owners:", so the "if you own the Actor" condition is already satisfied, right?

For non-owners: only available for Pay-Per-Event Actors (event costs only).
Not available for Pay-Per-Result Actors when you're not the Actor owner.
example: 0.2654
usageUsd:
allOf:
- oneOf:
- nullable: true
- $ref: ./RunUsage.yaml
- {}
nullable: true
description: >-
Platform usage costs breakdown in USD. Only present if you own the run AND are paying for platform usage
(Pay-Per-Usage, Rental, or Pay-Per-Event with usage costs like standby Actors).
Copy link
Contributor

@stetizu1 stetizu1 Jan 14, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am technically missing there "if you are Actor owner" case - you are then only paying for usage

Copy link
Contributor Author

@janbuchar janbuchar Jan 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That seems like too much detail to me honestly...

Not available for standard Pay-Per-Event Actors or Pay-Per-Result Actors owned by others.
$ref: ./RunUsage.yaml
Loading