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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.workspace_gid | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.start_at | string | Optional | Format: date-time |
query.end_at | string | Optional | Format: date-time |
query.division_gid | string | Optional | Format: id |
query.limit | integer | Optional | Minimum: 1 Maximum: 100 |
query.offset | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 1).data | array | Optional | |
$ (allOf 1).data[] | Model | Each item | Expand Get AI Studio credit utilization — response body — data, next page data item — Ai Studio Run Response |
$ (allOf 1).next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
$ (allOf 2) | Model | All variants apply | Expand 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
Schemas
Section titled “Schemas”3 more schemas are linked from the tables above, on the schema pages.
Get goals — response body — data, next page next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | *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).offset | string | Optional | Pagination offset for the request. Read only: true |
$ (anyOf 1).path | string | Optional | A relative path containing the query parameters to fetch for next_page Read only: true |
$ (anyOf 1).uri | string | Optional | A full uri containing the query parameters to fetch for next_page Format: uri Read only: true |
$ (anyOf 2) | null | Alternative |
Get AI Studio credit utilization — response body — data, next page data item — Ai Studio Run Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get AI Studio credit utilization — response body — data, next page data item gid, resource type |
$ (allOf 2) | object | All variants apply | A single AI Studio run (rule execution). The `gid` is stable and serves as the de-duplication key for incremental loads. |
$ (allOf 2).rule | JSON | Optional | |
$ (allOf 2).rule (anyOf 1) | Model | Alternative | Expand Get AI Studio credit utilization — response body — data, next page data item rule gid, name, resource type |
$ (allOf 2).rule (anyOf 2) | null | Alternative | |
$ (allOf 2).automation | JSON | Optional | |
$ (allOf 2).automation (anyOf 1) | Model | Alternative | Expand Get AI Studio credit utilization — response body — data, next page data item automation gid, name, resource type |
$ (allOf 2).automation (anyOf 2) | null | Alternative | |
$ (allOf 2).rule_owner | JSON | Optional | |
$ (allOf 2).rule_owner (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
$ (allOf 2).rule_owner (allOf 2) | object | All variants apply | The user who owns the rule. Read only: true |
$ (allOf 2).rule_owner (allOf 2).email | string | Optional | Read only: true |
$ (allOf 2).triggered_by | JSON | Optional | |
$ (allOf 2).triggered_by (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
$ (allOf 2).triggered_by (allOf 2) | object | All variants apply | The 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).email | string | Optional | Read only: true |
$ (allOf 2).triggering_container | JSON | Optional | |
$ (allOf 2).triggering_container (anyOf 1) | object | Alternative | The 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).gid | string | Optional | Read only: true |
$ (allOf 2).triggering_container (anyOf 1).resource_type | string | Optional | Known values: project, portfolio Read only: true |
$ (allOf 2).triggering_container (anyOf 2) | null | Alternative | |
$ (allOf 2).division | JSON | Optional | |
$ (allOf 2).division (anyOf 1) | object | Alternative | The 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).gid | string | Optional | Read only: true |
$ (allOf 2).division (anyOf 1).resource_type | string | Optional | Read only: true |
$ (allOf 2).division (anyOf 1).name | string | Optional | Read only: true |
$ (allOf 2).division (anyOf 2) | null | Alternative | |
$ (allOf 2).run_started_at | JSON | Optional | |
$ (allOf 2).run_started_at (anyOf 1) | string | Alternative | When the run was triggered. Format: date-time Read only: true |
$ (allOf 2).run_started_at (anyOf 2) | null | Alternative | |
$ (allOf 2).run_completed_at | JSON | Optional | |
$ (allOf 2).run_completed_at (anyOf 1) | string | Alternative | When 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) | null | Alternative | |
$ (allOf 2).status | string | Optional | The outcome of the run. Known values: success, failed, cancelled Read only: true |
$ (allOf 2).model | string | Optional | The LLM model used for the run. Read only: true |
$ (allOf 2).credits_used | JSON | Optional | |
$ (allOf 2).credits_used (anyOf 1) | number | Alternative | The number of credits consumed by the run. Read only: true |
$ (allOf 2).credits_used (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).credit_source | string | Optional | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get AI Studio credit utilization — response body — data, next page data item — sdk__Ai Studio Run Response |
next_page | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single AI Studio run (rule execution), representing the credits consumed by one execution of an AI Studio rule. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
Get users in a team — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | *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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The 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 |
gid | string | Optional | Read only: true |
resource_type | string | Optional | Read only: true |
name | string | Optional | Read only: true |
Get AI Studio credit utilization — response body — data, next page data item rule gid, name, resource type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The 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 |
gid | string | Optional | Read only: true |
resource_type | string | Optional | Read only: true |
name | string | Optional | Read only: true |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.