Skip to content

Asana: Get AI Studio credit utilization

Asana aiStudioUsageApi.getAiStudioRuns: arguments, response, policy and SDK examples.

← AI studio usage API operations · Get started

Operation asana.getaistudioruns

Provider route: GET /workspaces/{workspace_gid}/ai_studio/runs. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/asana with npm, or alter-sdk-asana with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AsanaIntegration } from "@alter-ai/asana";
async function execute(input: Parameters<AsanaIntegration["aiStudioUsageApi"]["getAiStudioRuns"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new AsanaIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.aiStudioUsageApi.getAiStudioRuns(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_asana import AsanaIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = AsanaIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.ai_studio_usage_api.get_ai_studio_runs(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.workspace_gidstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.start_atstringOptionalFormat: date-time
query.end_atstringOptionalFormat: date-time
query.division_gidstringOptionalFormat: id
query.limitintegerOptionalMinimum: 1
Maximum: 100
query.offsetstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)objectAll variants apply
$ (allOf 1).dataarrayOptional
$ (allOf 1).data[]ModelEach itemExpand Get AI Studio credit utilization — response body — data, next page data item — Ai Studio Run Response
$ (allOf 1).next_pageModelOptionalExpand Get goals — response body — data, next page next page
$ (allOf 2)ModelAll variants applyExpand Get AI Studio credit utilization — response body — data, next page

Referenced models: Get goals — response body — data, next page next page, Get AI Studio credit utilization — response body — data, next page data item — Ai Studio Run Response, Get AI Studio credit utilization — response body — data, next page

3 more schemas are linked from the tables above, on the schema pages.

Get goals — response body — data, next page next page
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative*Conditional*. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
$ (anyOf 1).offsetstringOptionalPagination offset for the request.
Read only: true
$ (anyOf 1).pathstringOptionalA relative path containing the query parameters to fetch for next_page
Read only: true
$ (anyOf 1).uristringOptionalA full uri containing the query parameters to fetch for next_page
Format: uri
Read only: true
$ (anyOf 2)nullAlternative
Get AI Studio credit utilization — response body — data, next page data item — Ai Studio Run Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get AI Studio credit utilization — response body — data, next page data item gid, resource type
$ (allOf 2)objectAll variants applyA single AI Studio run (rule execution). The `gid` is stable and serves as the de-duplication key for incremental loads.
$ (allOf 2).ruleJSONOptional
$ (allOf 2).rule (anyOf 1)ModelAlternativeExpand Get AI Studio credit utilization — response body — data, next page data item rule gid, name, resource type
$ (allOf 2).rule (anyOf 2)nullAlternative
$ (allOf 2).automationJSONOptional
$ (allOf 2).automation (anyOf 1)ModelAlternativeExpand Get AI Studio credit utilization — response body — data, next page data item automation gid, name, resource type
$ (allOf 2).automation (anyOf 2)nullAlternative
$ (allOf 2).rule_ownerJSONOptional
$ (allOf 2).rule_owner (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).rule_owner (allOf 2)objectAll variants applyThe user who owns the rule.
Read only: true
$ (allOf 2).rule_owner (allOf 2).emailstringOptionalRead only: true
$ (allOf 2).triggered_byJSONOptional
$ (allOf 2).triggered_by (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).triggered_by (allOf 2)objectAll variants applyThe user the run executed as, and to whom the credits are attributed. Usually the same as `rule_owner`, but can differ for chained or AI-teammate-triggered runs.
Read only: true
$ (allOf 2).triggered_by (allOf 2).emailstringOptionalRead only: true
$ (allOf 2).triggering_containerJSONOptional
$ (allOf 2).triggering_container (anyOf 1)objectAlternativeThe object the rule lives in (its container) — a project or portfolio — as a compact reference. `null` if the container is unavailable.
Read only: true
$ (allOf 2).triggering_container (anyOf 1).gidstringOptionalRead only: true
$ (allOf 2).triggering_container (anyOf 1).resource_typestringOptionalKnown values: project, portfolio
Read only: true
$ (allOf 2).triggering_container (anyOf 2)nullAlternative
$ (allOf 2).divisionJSONOptional
$ (allOf 2).division (anyOf 1)objectAlternativeThe division the actor belonged to at the time of the run, as a compact reference. `null` when division metering is not enabled for the domain. Not dereferenceable yet (no public Division API); `name` reflects the division's current state.
Read only: true
$ (allOf 2).division (anyOf 1).gidstringOptionalRead only: true
$ (allOf 2).division (anyOf 1).resource_typestringOptionalRead only: true
$ (allOf 2).division (anyOf 1).namestringOptionalRead only: true
$ (allOf 2).division (anyOf 2)nullAlternative
$ (allOf 2).run_started_atJSONOptional
$ (allOf 2).run_started_at (anyOf 1)stringAlternativeWhen the run was triggered.
Format: date-time
Read only: true
$ (allOf 2).run_started_at (anyOf 2)nullAlternative
$ (allOf 2).run_completed_atJSONOptional
$ (allOf 2).run_completed_at (anyOf 1)stringAlternativeWhen the run finished. `null` for runs that did not complete (e.g. cancelled). Runs still in progress don't appear in this endpoint (a usage record exists only once a run is metered), so this is non-null for every success/failed run.
Format: date-time
Read only: true
$ (allOf 2).run_completed_at (anyOf 2)nullAlternative
$ (allOf 2).statusstringOptionalThe outcome of the run.
Known values: success, failed, cancelled
Read only: true
$ (allOf 2).modelstringOptionalThe LLM model used for the run.
Read only: true
$ (allOf 2).credits_usedJSONOptional
$ (allOf 2).credits_used (anyOf 1)numberAlternativeThe number of credits consumed by the run.
Read only: true
$ (allOf 2).credits_used (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).credit_sourcestringOptionalWhether the credits were drawn from a paid or free balance.
Known values: paid, free
Read only: true

Referenced models: Get AI Studio credit utilization — response body — data, next page data item gid, resource type, Get users in a team — response body — data data item, Get AI Studio credit utilization — response body — data, next page data item automation gid, name, resource type, Get AI Studio credit utilization — response body — data, next page data item rule gid, name, resource type

Get AI Studio credit utilization — response body — data, next page
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get AI Studio credit utilization — response body — data, next page data item — sdk__Ai Studio Run Response
next_pageModelOptionalExpand Get goals — response body — data, next page next page

Referenced models: Get goals — response body — data, next page next page, Get AI Studio credit utilization — response body — data, next page data item — sdk__Ai Studio Run Response

Get AI Studio credit utilization — response body — data, next page data item gid, resource type
FieldTypePresenceDescription and constraints
$objectRootA single AI Studio run (rule execution), representing the credits consumed by one execution of an AI Studio rule.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
Get users in a team — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptional*Read-only except when same user as requester*. The user's name.
Get AI Studio credit utilization — response body — data, next page data item automation gid, name, resource type
FieldTypePresenceDescription and constraints
$objectRootThe multi-step automation (AutomationWorkflow) the step belonged to when it ran. `null` for standalone rules. Non-null for workflow steps regardless of whether the step itself was later deleted. Each step of a multi-step automation run is returned as its own row with the same `automation`, so group by `automation.gid` to reconstruct per-automation usage. Not dereferenceable yet (no public Automations API).
Read only: true
gidstringOptionalRead only: true
resource_typestringOptionalRead only: true
namestringOptionalRead only: true
Get AI Studio credit utilization — response body — data, next page data item rule gid, name, resource type
FieldTypePresenceDescription and constraints
$objectRootThe rule (AutomationStep) that ran, as a compact reference. Non-null for both standalone rules and multi-step automation steps as long as the step still exists. `null` if the step was deleted after the run. The Rules API is not yet public, so this is not dereferenceable today, but the shape is forward-compatible (consumers can key off `rule.gid`).
Read only: true
gidstringOptionalRead only: true
resource_typestringOptionalRead only: true
namestringOptionalRead only: true

SDK function policy ID: asana.getaistudioruns. Catalog operation: asana:getAiStudioRuns. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.