> ## Documentation Index > Fetch the complete documentation index at: https://docs.checkfu.com/llms.txt > Use this file to discover all available pages before exploring further. # List raw UsageLedger entries > Returns a page of append-only UsageEntry records, each carrying one authoritative measurement and its Workspace and subject attribution. ## OpenAPI ````yaml /openapi.json get /v1/usage openapi: 3.1.0 info: title: Checkfu API version: '2026-08-31' description: >- Authentication is declared per operation: API-key, runtime, or connector bearer; Automation signature; or credential-free pairing redemption. Every general Checkfu REST request requires the dated `Checkfu-Version` header (one of: 2026-08-31); the three MCP JSON-RPC transports use `MCP-Protocol-Version`, A2A uses `A2A-Version`, and the provider OAuth callback carries neither Checkfu header. API keys resolve one Workspace without a request selector; authenticated responses identify it with `Checkfu-Workspace-Id`. servers: - url: https://api.checkfu.com security: - bearerAuth: [] tags: - name: organizations - name: sourceRepositories - name: tenants - name: workspaces - name: principals - name: principalGroups - name: principalAccessCredentials - name: apiKeys - name: agents - name: harnessRuntime - name: permissionAssignments - name: actionPolicies - name: files - name: memoryStores - name: modelCredentials - name: modelRoutingProfiles - name: toolSources - name: skills - name: skillSources - name: agentBlueprints - name: skillProposals - name: instructionProposals - name: catalog - name: managedTools - name: concepts - name: support - name: connections - name: connectionVaults - name: connectionAssignments - name: connectedRuntimes - name: fileTrees - name: collaboration - name: automationGraphs - name: automations - name: actionApprovals - name: standingApprovals - name: workloadReviewPolicies - name: usage - name: models - name: outcomes - name: budgets - name: billing - name: sessions - name: audit - name: sessionExports - name: runs - name: runnerPools - name: transcripts - name: sessionWatches - name: sessionCapsules - name: sessionTrajectories - name: webhookEndpoints - name: integrationGateway - name: workEnvironments - name: computers - name: computerScreens - name: computerBrowserObservations - name: computerBrowserActions - name: environments - name: computerHeadlessOperations - name: vaults - name: apiMcp - name: a2a paths: /v1/usage: get: tags: - usage summary: List raw UsageLedger entries description: >- Returns a page of append-only UsageEntry records, each carrying one authoritative measurement and its Workspace and subject attribution. Agent execution names its Session, Run, RunAttempt, and Agent. Lightweight model evaluations instead carry an evaluation parent and slot, with null Run and RunAttempt coordinates; Session and Agent attribution is present only when applicable. Filter by the supported attribution dimensions and by `order`; each page is clamped to at most 1,000 entries. Prefer `usage.getUsageSeries` for totals. Checkfu support posture: alpha; hosted. Required evidence journey: usage-series. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities. operationId: usage.listUsage parameters: - name: checkfu-version in: header schema: type: string enum: - '2026-08-31' required: true - name: limit in: query schema: type: integer minimum: 1 required: false - name: page in: query schema: type: string pattern: ^c1_[0-9a-z]+$ required: false - name: principal_id in: query schema: $ref: '#/components/schemas/PrincipalId' required: false - name: agent_id in: query schema: $ref: '#/components/schemas/AgentId' required: false - name: collaboration_space_id in: query schema: $ref: '#/components/schemas/CollaborationSpaceId' required: false - name: automation_id in: query schema: $ref: '#/components/schemas/AutomationId' required: false - name: session_id in: query schema: $ref: '#/components/schemas/SessionId' required: false - name: run in: query schema: $ref: '#/components/schemas/RunId' required: false - name: attempt in: query schema: $ref: '#/components/schemas/RunAttemptId' required: false - name: order in: query schema: type: string enum: - asc - desc required: false responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/UsageEntrySubject' next_page: anyOf: - type: string - type: 'null' required: - data - next_page additionalProperties: false headers: checkfu-workspace-id: description: The Workspace resolved from the authenticated bearer credential. required: true schema: $ref: '#/components/schemas/WorkspaceId' '400': description: Typed Checkfu wire error content: application/json: schema: $ref: '#/components/schemas/ValidationMalformedError' '401': description: Typed Checkfu wire error content: application/json: schema: type: object required: - error properties: error: type: object required: - type - message - more properties: type: type: string enum: - auth.invalid_key message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#auth-invalid-key description: >- Stable public documentation and remedy for this error type. additionalProperties: false additionalProperties: false '403': description: >- The organization, tenant, or workspace backing this key is administratively disabled. | Deployment governance or retention policy denied the request. content: application/json: schema: anyOf: - type: object required: - error properties: error: type: object properties: type: type: string enum: - auth.disabled_tenancy message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#auth-disabled-tenancy description: >- Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false additionalProperties: false - $ref: '#/components/schemas/PolicyDeniedError' '429': description: Typed Checkfu wire error headers: retry-after: description: >- Delay in seconds for rate limits or deployment quotas with a known release or UTC reset boundary required: false schema: type: integer minimum: 1 content: application/json: schema: type: object required: - error properties: error: type: object required: - type - message - more properties: type: type: string enum: - budget.exceeded message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#budget-exceeded description: >- Stable public documentation and remedy for this error type. additionalProperties: false additionalProperties: false '500': description: >- An unexpected internal failure occurred; the message contains an opaque incident reference. content: application/json: schema: $ref: '#/components/schemas/RuntimeInternalError' '503': description: Authorization could not be evaluated. Retry the same request. content: application/json: schema: $ref: '#/components/schemas/AuthorizationUnavailableError' security: - bearerAuth: [] components: schemas: PrincipalId: type: string pattern: ^prin_[0-9a-f]{32}$ AgentId: type: string pattern: ^agent_[0-9a-f]{32}$ CollaborationSpaceId: type: string pattern: ^cspace_[0-9a-f]{32}$ AutomationId: type: string pattern: ^auto_[0-9a-f]{32}$ SessionId: type: string pattern: ^sess_[0-9a-f]{32}$ RunId: type: string pattern: ^run_[0-9a-f]{32}$ RunAttemptId: type: string pattern: ^ratt_[0-9a-f]{32}$ UsageEntrySubject: anyOf: - type: object properties: id: $ref: '#/components/schemas/UsageEntryId' session_id: anyOf: - $ref: '#/components/schemas/SessionId' - type: 'null' run: anyOf: - $ref: '#/components/schemas/RunId' - type: 'null' attempt: type: 'null' agent_id: anyOf: - $ref: '#/components/schemas/AgentId' - type: 'null' collaboration_space_id: anyOf: - $ref: '#/components/schemas/CollaborationSpaceId' - type: 'null' automation_id: anyOf: - $ref: '#/components/schemas/AutomationId' - type: 'null' evaluation: false execution_origin: false sequence: type: integer exclusiveMinimum: 0 workspace_id: $ref: '#/components/schemas/WorkspaceId' principal_id: $ref: '#/components/schemas/Union_303' anonymous_subject_ref: $ref: '#/components/schemas/Union_304' recorded_at: $ref: '#/components/schemas/UsageTimestamp' measurement: type: object properties: kind: type: string enum: - managed_tool tool_invocation_id: $ref: '#/components/schemas/ToolInvocationId' selection: $ref: '#/components/schemas/ManagedToolSelection' origin: anyOf: - type: object properties: origin_type: type: string enum: - session session_id: $ref: '#/components/schemas/SessionId' run: $ref: '#/components/schemas/RunId' required: - origin_type - session_id - run additionalProperties: false - type: object properties: origin_type: type: string enum: - automation automation_id: $ref: '#/components/schemas/AutomationId' automation_firing_id: $ref: '#/components/schemas/AutomationFiringId' automation_step_id: type: string allOf: - minLength: 1 - maxLength: 64 - pattern: ^[A-Za-z0-9_]+$ required: - origin_type - automation_id - automation_firing_id - automation_step_id additionalProperties: false - type: object properties: origin_type: type: string enum: - api required: - origin_type additionalProperties: false price: $ref: '#/components/schemas/ManagedToolPrice' outcome: anyOf: - type: object properties: outcome_type: type: string enum: - valid_result empty_result: type: boolean required: - outcome_type - empty_result additionalProperties: false - type: object properties: outcome_type: type: string enum: - failed - canceled dispatched: type: boolean required: - outcome_type - dispatched additionalProperties: false required: - kind - tool_invocation_id - selection - origin - price - outcome additionalProperties: false cost: type: object properties: tokens: false active_ms: false storage_mib_ms: false running_ms: false managed_tool_calls: type: number enum: - 1 billed_microusd: type: integer allOf: - minimum: 0 - maximum: 9007199254740991 rounding_remainder_millionths: type: number enum: - 0 required: - managed_tool_calls - billed_microusd - rounding_remainder_millionths additionalProperties: false required: - id - session_id - run - attempt - agent_id - sequence - workspace_id - principal_id - anonymous_subject_ref - recorded_at - measurement - cost additionalProperties: false - anyOf: - type: object properties: id: $ref: '#/components/schemas/UsageEntryId' session_id: $ref: '#/components/schemas/SessionId' run: $ref: '#/components/schemas/RunId' attempt: type: 'null' agent_id: $ref: '#/components/schemas/AgentId' collaboration_space_id: anyOf: - $ref: '#/components/schemas/CollaborationSpaceId' - type: 'null' automation_id: anyOf: - $ref: '#/components/schemas/AutomationId' - type: 'null' evaluation: false execution_origin: type: string enum: - native_sdk sequence: type: integer exclusiveMinimum: 0 workspace_id: $ref: '#/components/schemas/WorkspaceId' principal_id: $ref: '#/components/schemas/Union_303' anonymous_subject_ref: $ref: '#/components/schemas/Union_304' recorded_at: $ref: '#/components/schemas/UsageTimestamp' measurement: $ref: '#/components/schemas/Objects_155' cost: $ref: '#/components/schemas/Objects_157' required: - id - session_id - run - attempt - agent_id - execution_origin - sequence - workspace_id - principal_id - anonymous_subject_ref - recorded_at - measurement - cost additionalProperties: false - type: object properties: id: $ref: '#/components/schemas/UsageEntryId' session_id: $ref: '#/components/schemas/SessionId' run: $ref: '#/components/schemas/RunId' attempt: $ref: '#/components/schemas/RunAttemptId' agent_id: $ref: '#/components/schemas/AgentId' collaboration_space_id: anyOf: - $ref: '#/components/schemas/CollaborationSpaceId' - type: 'null' automation_id: anyOf: - $ref: '#/components/schemas/AutomationId' - type: 'null' evaluation: false execution_origin: false sequence: type: integer exclusiveMinimum: 0 workspace_id: $ref: '#/components/schemas/WorkspaceId' principal_id: $ref: '#/components/schemas/Union_303' anonymous_subject_ref: $ref: '#/components/schemas/Union_304' recorded_at: $ref: '#/components/schemas/UsageTimestamp' measurement: $ref: '#/components/schemas/Objects_155' cost: $ref: '#/components/schemas/Objects_157' required: - id - session_id - run - attempt - agent_id - sequence - workspace_id - principal_id - anonymous_subject_ref - recorded_at - measurement - cost additionalProperties: false - type: object properties: id: $ref: '#/components/schemas/UsageEntryId' session_id: anyOf: - $ref: '#/components/schemas/SessionId' - type: 'null' run: type: 'null' attempt: type: 'null' agent_id: anyOf: - $ref: '#/components/schemas/AgentId' - type: 'null' collaboration_space_id: anyOf: - $ref: '#/components/schemas/CollaborationSpaceId' - type: 'null' automation_id: anyOf: - $ref: '#/components/schemas/AutomationId' - type: 'null' evaluation: $ref: '#/components/schemas/EvaluationUsageOrigin' execution_origin: false sequence: type: integer exclusiveMinimum: 0 workspace_id: $ref: '#/components/schemas/WorkspaceId' principal_id: $ref: '#/components/schemas/Union_303' anonymous_subject_ref: $ref: '#/components/schemas/Union_304' recorded_at: $ref: '#/components/schemas/UsageTimestamp' measurement: $ref: '#/components/schemas/Objects_155' cost: $ref: '#/components/schemas/Objects_157' required: - id - session_id - run - attempt - agent_id - evaluation - sequence - workspace_id - principal_id - anonymous_subject_ref - recorded_at - measurement - cost additionalProperties: false - anyOf: - type: object properties: id: $ref: '#/components/schemas/UsageEntryId' session_id: $ref: '#/components/schemas/SessionId' run: $ref: '#/components/schemas/RunId' attempt: type: 'null' agent_id: $ref: '#/components/schemas/AgentId' collaboration_space_id: anyOf: - $ref: '#/components/schemas/CollaborationSpaceId' - type: 'null' automation_id: anyOf: - $ref: '#/components/schemas/AutomationId' - type: 'null' evaluation: false execution_origin: type: string enum: - native_sdk sequence: type: integer exclusiveMinimum: 0 workspace_id: $ref: '#/components/schemas/WorkspaceId' principal_id: $ref: '#/components/schemas/Union_303' anonymous_subject_ref: $ref: '#/components/schemas/Union_304' recorded_at: $ref: '#/components/schemas/UsageTimestamp' measurement: $ref: '#/components/schemas/Objects_158' cost: $ref: '#/components/schemas/Objects_160' required: - id - session_id - run - attempt - agent_id - execution_origin - sequence - workspace_id - principal_id - anonymous_subject_ref - recorded_at - measurement - cost additionalProperties: false - type: object properties: id: $ref: '#/components/schemas/UsageEntryId' session_id: $ref: '#/components/schemas/SessionId' run: $ref: '#/components/schemas/RunId' attempt: $ref: '#/components/schemas/RunAttemptId' agent_id: $ref: '#/components/schemas/AgentId' collaboration_space_id: anyOf: - $ref: '#/components/schemas/CollaborationSpaceId' - type: 'null' automation_id: anyOf: - $ref: '#/components/schemas/AutomationId' - type: 'null' evaluation: false execution_origin: false sequence: type: integer exclusiveMinimum: 0 workspace_id: $ref: '#/components/schemas/WorkspaceId' principal_id: $ref: '#/components/schemas/Union_303' anonymous_subject_ref: $ref: '#/components/schemas/Union_304' recorded_at: $ref: '#/components/schemas/UsageTimestamp' measurement: $ref: '#/components/schemas/Objects_158' cost: $ref: '#/components/schemas/Objects_160' required: - id - session_id - run - attempt - agent_id - sequence - workspace_id - principal_id - anonymous_subject_ref - recorded_at - measurement - cost additionalProperties: false - type: object properties: id: $ref: '#/components/schemas/UsageEntryId' session_id: $ref: '#/components/schemas/SessionId' run: $ref: '#/components/schemas/RunId' attempt: $ref: '#/components/schemas/RunAttemptId' agent_id: $ref: '#/components/schemas/AgentId' collaboration_space_id: anyOf: - $ref: '#/components/schemas/CollaborationSpaceId' - type: 'null' automation_id: anyOf: - $ref: '#/components/schemas/AutomationId' - type: 'null' evaluation: false execution_origin: false sequence: type: integer exclusiveMinimum: 0 workspace_id: $ref: '#/components/schemas/WorkspaceId' principal_id: $ref: '#/components/schemas/Union_303' anonymous_subject_ref: $ref: '#/components/schemas/Union_304' recorded_at: $ref: '#/components/schemas/UsageTimestamp' measurement: $ref: '#/components/schemas/SandboxComputeInterval' cost: type: object properties: tokens: false active_ms: type: integer minimum: 0 storage_mib_ms: false running_ms: false billed_microusd: false required: - active_ms additionalProperties: false required: - id - session_id - run - attempt - agent_id - sequence - workspace_id - principal_id - anonymous_subject_ref - recorded_at - measurement - cost additionalProperties: false - type: object properties: id: $ref: '#/components/schemas/UsageEntryId' session_id: $ref: '#/components/schemas/SessionId' run: $ref: '#/components/schemas/RunId' attempt: $ref: '#/components/schemas/RunAttemptId' agent_id: $ref: '#/components/schemas/AgentId' collaboration_space_id: anyOf: - $ref: '#/components/schemas/CollaborationSpaceId' - type: 'null' automation_id: anyOf: - $ref: '#/components/schemas/AutomationId' - type: 'null' evaluation: false execution_origin: false sequence: type: integer exclusiveMinimum: 0 workspace_id: $ref: '#/components/schemas/WorkspaceId' principal_id: $ref: '#/components/schemas/Union_303' anonymous_subject_ref: $ref: '#/components/schemas/Union_304' recorded_at: $ref: '#/components/schemas/UsageTimestamp' measurement: $ref: '#/components/schemas/SnapshotRetentionInterval' cost: type: object properties: tokens: false active_ms: false storage_mib_ms: type: integer minimum: 0 running_ms: false billed_microusd: false required: - storage_mib_ms additionalProperties: false required: - id - session_id - run - attempt - agent_id - sequence - workspace_id - principal_id - anonymous_subject_ref - recorded_at - measurement - cost additionalProperties: false - type: object properties: id: $ref: '#/components/schemas/UsageEntryId' session_id: $ref: '#/components/schemas/SessionId' run: $ref: '#/components/schemas/RunId' attempt: $ref: '#/components/schemas/RunAttemptId' agent_id: $ref: '#/components/schemas/AgentId' collaboration_space_id: anyOf: - $ref: '#/components/schemas/CollaborationSpaceId' - type: 'null' automation_id: anyOf: - $ref: '#/components/schemas/AutomationId' - type: 'null' evaluation: false execution_origin: false sequence: type: integer exclusiveMinimum: 0 workspace_id: $ref: '#/components/schemas/WorkspaceId' principal_id: $ref: '#/components/schemas/Union_303' anonymous_subject_ref: $ref: '#/components/schemas/Union_304' recorded_at: $ref: '#/components/schemas/UsageTimestamp' measurement: $ref: '#/components/schemas/SessionRuntimeInterval' cost: $ref: '#/components/schemas/Union_306' required: - id - session_id - run - attempt - agent_id - sequence - workspace_id - principal_id - anonymous_subject_ref - recorded_at - measurement - cost additionalProperties: false - type: object properties: id: $ref: '#/components/schemas/UsageEntryId' session_id: $ref: '#/components/schemas/SessionId' run: $ref: '#/components/schemas/RunId' attempt: type: 'null' agent_id: $ref: '#/components/schemas/AgentId' collaboration_space_id: anyOf: - $ref: '#/components/schemas/CollaborationSpaceId' - type: 'null' automation_id: anyOf: - $ref: '#/components/schemas/AutomationId' - type: 'null' evaluation: false execution_origin: false sequence: type: integer exclusiveMinimum: 0 workspace_id: $ref: '#/components/schemas/WorkspaceId' principal_id: $ref: '#/components/schemas/Union_303' anonymous_subject_ref: $ref: '#/components/schemas/Union_304' recorded_at: $ref: '#/components/schemas/UsageTimestamp' measurement: $ref: '#/components/schemas/SessionRuntimeInterval' cost: $ref: '#/components/schemas/Union_306' required: - id - session_id - run - attempt - agent_id - sequence - workspace_id - principal_id - anonymous_subject_ref - recorded_at - measurement - cost additionalProperties: false - type: object properties: id: $ref: '#/components/schemas/UsageEntryId' session_id: $ref: '#/components/schemas/SessionId' run: $ref: '#/components/schemas/RunId' attempt: $ref: '#/components/schemas/RunAttemptId' agent_id: $ref: '#/components/schemas/AgentId' collaboration_space_id: anyOf: - $ref: '#/components/schemas/CollaborationSpaceId' - type: 'null' automation_id: anyOf: - $ref: '#/components/schemas/AutomationId' - type: 'null' evaluation: false execution_origin: false sequence: type: integer exclusiveMinimum: 0 workspace_id: $ref: '#/components/schemas/WorkspaceId' principal_id: $ref: '#/components/schemas/Union_303' anonymous_subject_ref: $ref: '#/components/schemas/Union_304' recorded_at: $ref: '#/components/schemas/UsageTimestamp' measurement: type: object properties: kind: type: string enum: - web_search requests: type: integer minimum: 0 required: - kind - requests additionalProperties: false cost: type: object properties: tokens: false active_ms: false storage_mib_ms: false running_ms: false requests: type: integer minimum: 0 billed_microusd: type: integer allOf: - minimum: 0 - maximum: 9007199254740991 rounding_remainder_millionths: type: integer minimum: 0 required: - requests - billed_microusd - rounding_remainder_millionths additionalProperties: false required: - id - session_id - run - attempt - agent_id - sequence - workspace_id - principal_id - anonymous_subject_ref - recorded_at - measurement - cost additionalProperties: false WorkspaceId: type: string pattern: ^wrkspc_[0-9a-f]{32}$ ValidationMalformedError: type: object properties: error: type: object properties: type: type: string enum: - validation.malformed message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#validation-malformed description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: >- The request could not be decoded or violated a declared input constraint. PolicyDeniedError: type: object properties: error: type: object properties: type: type: string enum: - policy.denied message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#policy-denied description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: Deployment governance or retention policy denied the request. RuntimeInternalError: type: object properties: error: type: object properties: type: type: string enum: - runtime.internal message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#runtime-internal description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: >- An unexpected internal failure occurred; the message contains an opaque incident reference. AuthorizationUnavailableError: type: object properties: error: type: object properties: type: type: string enum: - auth.authorization_unavailable message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#auth-authorization-unavailable description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: Authorization could not be evaluated. Retry the same request. UsageEntryId: type: string pattern: ^use_[0-9a-f]{32}$ Union_303: anyOf: - $ref: '#/components/schemas/PrincipalId' - type: 'null' Union_304: anyOf: - type: string allOf: - minLength: 1 - type: 'null' UsageTimestamp: type: string allOf: - maxLength: 24 - pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$ x-checkfu-current-timestamp: true description: A canonical UTC ISO-8601 usage timestamp with millisecond precision. ToolInvocationId: type: string pattern: ^tinv_[0-9a-f]{32}$ ManagedToolSelection: type: object properties: managed_tool_id: $ref: '#/components/schemas/ManagedToolId' managed_tool_release_id: $ref: '#/components/schemas/ManagedToolReleaseId' required: - managed_tool_id - managed_tool_release_id additionalProperties: false AutomationFiringId: type: string pattern: ^afire_[0-9a-f]{32}$ ManagedToolPrice: type: object properties: rate_card_id: $ref: '#/components/schemas/BillingRateCardId' price_microusd: type: integer allOf: - minimum: 0 - maximum: 9007199254740991 billing_basis: type: string enum: - valid_result - admitted_dispatch valid_empty_result_billable: type: boolean required: - rate_card_id - price_microusd - billing_basis - valid_empty_result_billable additionalProperties: false description: >- One published fixed price per logical invocation; polling and result recovery do not add calls. Objects_155: type: object properties: kind: type: string enum: - model model_routing_profile_id: anyOf: - $ref: '#/components/schemas/ModelRoutingProfileId' - type: 'null' candidate: $ref: '#/components/schemas/Objects_156' tokens: $ref: '#/components/schemas/Objects_77' measured_at: $ref: '#/components/schemas/UsageTimestamp' supply_class: $ref: '#/components/schemas/Union_305' basis: anyOf: - type: string enum: - admitted_maximum required: - kind - model_routing_profile_id - candidate - tokens - measured_at - supply_class additionalProperties: false Objects_157: type: object properties: tokens: type: integer minimum: 0 model_spend_microusd: anyOf: - type: integer allOf: - minimum: 0 - maximum: 9007199254740991 - type: 'null' active_ms: false storage_mib_ms: false running_ms: false billed_microusd: false required: - tokens additionalProperties: false EvaluationUsageOrigin: type: object properties: parent_kind: type: string allOf: - minLength: 1 parent_id: type: string allOf: - minLength: 1 slot: type: string allOf: - minLength: 1 required: - parent_kind - parent_id - slot additionalProperties: false description: The parent and operation slot that own one non-Agent model evaluation. Objects_158: type: object properties: kind: type: string enum: - model_unit model_routing_profile_id: anyOf: - $ref: '#/components/schemas/ModelRoutingProfileId' - type: 'null' candidate: $ref: '#/components/schemas/Objects_156' usage: $ref: '#/components/schemas/Objects_159' measured_at: $ref: '#/components/schemas/UsageTimestamp' supply_class: $ref: '#/components/schemas/Union_305' required: - kind - model_routing_profile_id - candidate - usage - measured_at - supply_class additionalProperties: false Objects_160: type: object properties: tokens: false active_ms: false storage_mib_ms: false running_ms: false billed_microusd: false unit: $ref: '#/components/schemas/Union_299' quantity_millionths: type: integer minimum: 0 model_spend_microusd: anyOf: - type: integer allOf: - minimum: 0 - maximum: 9007199254740991 - type: 'null' required: - unit - quantity_millionths additionalProperties: false SandboxComputeInterval: type: object properties: kind: type: string enum: - sandbox_compute provider: type: string allOf: - minLength: 1 environment_id: $ref: '#/components/schemas/EnvironmentId' period_started_at: $ref: '#/components/schemas/UsageTimestamp' period_ended_at: $ref: '#/components/schemas/UsageTimestamp' active_ms: type: integer minimum: 0 required: - kind - provider - environment_id - period_started_at - period_ended_at - active_ms additionalProperties: false SnapshotRetentionInterval: type: object properties: kind: type: string enum: - snapshot_retention checkpoint_id: $ref: '#/components/schemas/CheckpointId' provider: type: string allOf: - minLength: 1 environment_id: $ref: '#/components/schemas/EnvironmentId' storage_mib: type: integer exclusiveMinimum: 0 period_started_at: $ref: '#/components/schemas/UsageTimestamp' period_ended_at: $ref: '#/components/schemas/UsageTimestamp' retained_ms: type: integer minimum: 0 required: - kind - checkpoint_id - provider - environment_id - storage_mib - period_started_at - period_ended_at - retained_ms additionalProperties: false SessionRuntimeInterval: type: object properties: kind: type: string enum: - session_runtime thread_id: anyOf: - $ref: '#/components/schemas/SessionThreadId' - type: 'null' placement: type: string enum: - hosted_sandbox - runner - cloudflare_durable_object period_started_at: $ref: '#/components/schemas/UsageTimestamp' period_ended_at: $ref: '#/components/schemas/UsageTimestamp' running_ms: type: integer minimum: 0 producer_version: type: number enum: - 1 - 2 - 3 required: - kind - thread_id - placement - period_started_at - period_ended_at - running_ms additionalProperties: false Union_306: anyOf: - type: object properties: tokens: false active_ms: false storage_mib_ms: false running_ms: type: integer minimum: 0 billed_microusd: type: integer allOf: - minimum: 0 - maximum: 9007199254740991 rounding_remainder_millionths: type: integer minimum: 0 required: - running_ms - billed_microusd - rounding_remainder_millionths additionalProperties: false - type: object properties: tokens: false active_ms: false storage_mib_ms: false running_ms: type: integer minimum: 0 billed_microusd: type: 'null' rounding_remainder_millionths: type: 'null' required: - running_ms - billed_microusd - rounding_remainder_millionths additionalProperties: false ManagedToolId: type: string pattern: ^mtl_[0-9a-f]{32}$ ManagedToolReleaseId: type: string pattern: ^mtrel_[0-9a-f]{32}$ BillingRateCardId: type: string pattern: ^rate_[0-9a-f]{32}$ ModelRoutingProfileId: type: string pattern: ^mrp_[0-9a-f]{32}$ Objects_156: type: object properties: tier: $ref: '#/components/schemas/Union_132' provider: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ model: type: string allOf: - minLength: 1 - maxLength: 255 context_window_tokens: type: integer exclusiveMinimum: 0 native_capabilities: anyOf: - type: object properties: version: type: number enum: - 1 wire_format: type: string enum: - openai_chat max_output_tokens: type: integer exclusiveMinimum: 0 input_modalities: type: array prefixItems: - type: string enum: - text - image minItems: 1 items: type: string enum: - text - image reasoning: type: boolean thinking_levels: $ref: '#/components/schemas/Objects_64' compatibility: type: object properties: supportsStore: type: boolean supportsDeveloperRole: type: boolean supportsReasoningEffort: type: boolean supportsUsageInStreaming: type: boolean supportsFinishReason: type: boolean maxTokensField: type: string enum: - max_tokens - max_completion_tokens requiresToolResultName: type: boolean requiresAssistantAfterToolResult: type: boolean requiresThinkingAsText: type: boolean requiresReasoningContentOnAssistantMessages: type: boolean thinkingFormat: type: string enum: - openai - openrouter - deepseek - together - zai - qwen - string-thinking - ant-ling zaiToolStream: type: boolean supportsStrictMode: type: boolean supportsOpenAIGrammarTools: type: boolean supportsMidConvoSystemMessages: type: boolean supportsMidConvoToolAdditions: type: boolean supportsThinkingTokenBudget: type: boolean thinkingTokenBudgetField: type: string enum: - thinking_token_budget - thinking_budget - thinking_budget_tokens required: - supportsStore - supportsDeveloperRole - supportsReasoningEffort - supportsUsageInStreaming - supportsFinishReason - maxTokensField - requiresToolResultName - requiresAssistantAfterToolResult - requiresThinkingAsText - requiresReasoningContentOnAssistantMessages - thinkingFormat - zaiToolStream - supportsStrictMode - supportsOpenAIGrammarTools - supportsMidConvoSystemMessages - supportsMidConvoToolAdditions - supportsThinkingTokenBudget additionalProperties: false required: - version - wire_format - max_output_tokens - input_modalities - reasoning - thinking_levels - compatibility additionalProperties: false - type: object properties: version: type: number enum: - 1 wire_format: type: string enum: - openai_responses max_output_tokens: type: integer exclusiveMinimum: 0 input_modalities: type: array prefixItems: - type: string enum: - text - image minItems: 1 items: type: string enum: - text - image reasoning: type: boolean thinking_levels: $ref: '#/components/schemas/Objects_64' compatibility: type: object properties: supportsDeveloperRole: type: boolean supportsMidConvoSystemMessages: type: boolean supportsStrictMode: type: boolean supportsOpenAIGrammarTools: type: boolean supportsAdditionalTools: type: boolean supportsToolSearch: type: boolean supportsExplicitPromptCacheMode: type: boolean supportsMaxOutputTokens: type: boolean required: - supportsDeveloperRole - supportsMidConvoSystemMessages - supportsStrictMode - supportsOpenAIGrammarTools - supportsAdditionalTools - supportsToolSearch - supportsExplicitPromptCacheMode - supportsMaxOutputTokens additionalProperties: false required: - version - wire_format - max_output_tokens - input_modalities - reasoning - thinking_levels - compatibility additionalProperties: false - type: object properties: version: type: number enum: - 1 wire_format: type: string enum: - anthropic_messages max_output_tokens: type: integer exclusiveMinimum: 0 input_modalities: type: array prefixItems: - type: string enum: - text - image minItems: 1 items: type: string enum: - text - image reasoning: type: boolean thinking_levels: $ref: '#/components/schemas/Objects_64' compatibility: type: object properties: supportsEagerToolInputStreaming: type: boolean supportsCacheControlOnTools: type: boolean supportsTemperature: type: boolean forceAdaptiveThinking: type: boolean allowEmptySignature: type: boolean supportsStrictTools: type: boolean supportsMidConvoEffort: type: boolean supportsMidConvoSystemMessages: type: boolean supportsMidConvoToolChanges: type: boolean required: - supportsEagerToolInputStreaming - supportsCacheControlOnTools - supportsTemperature - forceAdaptiveThinking - allowEmptySignature - supportsStrictTools - supportsMidConvoEffort - supportsMidConvoSystemMessages - supportsMidConvoToolChanges additionalProperties: false required: - version - wire_format - max_output_tokens - input_modalities - reasoning - thinking_levels - compatibility additionalProperties: false native_sdk_estimation: $ref: '#/components/schemas/Objects_65' effort: type: string enum: - minimal - low - medium - high - max speed: type: string enum: - standard - fast inference_geo: $ref: '#/components/schemas/Union_11' openrouter_max_price: $ref: '#/components/schemas/OpenRouterMaxPrice' required: - tier - provider - model additionalProperties: false Objects_77: type: object properties: input_tokens: type: integer minimum: 0 cached_input_tokens: type: integer minimum: 0 cache_write_input_tokens: type: integer minimum: 0 output_tokens: type: integer minimum: 0 reasoning_output_tokens: type: integer minimum: 0 total_tokens: type: integer minimum: 0 required: - input_tokens - cached_input_tokens - cache_write_input_tokens - output_tokens - reasoning_output_tokens - total_tokens additionalProperties: false Union_305: type: string enum: - platform_supply - byok - unknown Objects_159: type: object properties: unit: $ref: '#/components/schemas/Union_299' quantity_millionths: type: integer minimum: 0 required: - unit - quantity_millionths additionalProperties: false Union_299: type: string enum: - image - video_second - compute_second EnvironmentId: type: string pattern: ^env_[0-9a-f]{32}$ CheckpointId: type: string pattern: ^ckpt_[0-9a-f]{32}$ SessionThreadId: type: string pattern: ^sthr_[0-9a-f]{32}$ Union_132: type: string enum: - default - planning - tool_loop Objects_64: type: object properties: 'off': $ref: '#/components/schemas/Union_135' minimal: $ref: '#/components/schemas/Union_135' low: $ref: '#/components/schemas/Union_135' medium: $ref: '#/components/schemas/Union_135' high: $ref: '#/components/schemas/Union_135' xhigh: $ref: '#/components/schemas/Union_135' max: $ref: '#/components/schemas/Union_135' required: - 'off' - minimal - low - medium - high - xhigh - max additionalProperties: false Objects_65: type: object properties: version: type: number enum: - 1 unit: type: string enum: - usd_per_million_tokens source: type: string enum: - profile_declared input: type: number minimum: 0 output: type: number minimum: 0 cache_read: type: number minimum: 0 cache_write: type: number minimum: 0 required: - version - unit - source - input - output - cache_read - cache_write additionalProperties: false Union_11: type: string enum: - global - us OpenRouterMaxPrice: type: object properties: prompt: type: number allOf: - minimum: 0 - maximum: 1000 completion: type: number allOf: - minimum: 0 - maximum: 1000 required: - prompt - completion additionalProperties: false description: >- maximum OpenRouter prompt and completion prices in USD per million tokens Union_135: anyOf: - type: string allOf: - minLength: 1 - maxLength: 255 - type: 'null' securitySchemes: bearerAuth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.