> ## Documentation Index > Fetch the complete documentation index at: https://docs.roark.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get simulation run cost > The billable spend for one simulation run (run plan job), split by cost type, with the spend of each simulated call in it. Safe to call while the run is in progress: totals reflect the costs recorded so far. Amounts are billable spend only, in exact micro-dollars (`*UsdMicros`) and dollars (`*Usd`, for display). Requires an API key with the `billing:read` permission. ## OpenAPI ````yaml /api-reference/openapi.documented.json get /v1/simulation/plan/job/{jobId}/cost openapi: 3.1.0 info: title: Roark Analytics API description: >- The Roark Analytics API gives you access to the same API that powers the award winning Roark Analytics platform. version: 1.0.0 servers: - description: Production url: https://api.roark.ai security: - Bearer: [] tags: - name: Agent - name: Agent Endpoint - name: Call - name: Chat - name: Metric - name: Metric Policy - name: Metric Collection Job - name: Customer Flow - name: Customer Flow Edge Case - name: Simulation - name: Simulation Persona - name: Simulation Environment - name: Simulation Scenario - name: Simulation Run Plan - name: Simulation Template - name: Simulation Run Plan Job - name: Simulation Job - name: HTTP Request Definition - name: Webhook - name: Issue - name: Autoimprove - name: Agent Config - name: Knowledge Base - name: Config - name: Organization Project - name: Organization Project Member - name: Organization Project API Key - name: Organization Config - name: CLI Auth - name: Me - name: Project - name: Usage - name: Analytics - name: Dashboard - name: Benchmark - name: Health - name: Prospect Simulation paths: /v1/simulation/plan/job/{jobId}/cost: get: tags: - Simulation Run Plan Job summary: Get simulation run cost description: >- The billable spend for one simulation run (run plan job), split by cost type, with the spend of each simulated call in it. Safe to call while the run is in progress: totals reflect the costs recorded so far. Amounts are billable spend only, in exact micro-dollars (`*UsdMicros`) and dollars (`*Usd`, for display). Requires an API key with the `billing:read` permission. operationId: getV1SimulationPlanJobByJobIdCost parameters: - in: path name: jobId schema: type: string format: uuid required: true responses: '200': description: The run’s cost content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/SimulationRunCost' required: - data '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Authentication error example: type: authentication code: unauthorized message: Authentication required description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Permission error example: type: forbidden code: permission_denied message: You do not have permission to access this resource description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Not found error example: type: not_found code: resource_not_found message: The requested resource could not be found description: Simulation run not found '429': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Rate limit error example: type: rate_limit code: too_many_requests message: Rate limit exceeded description: Too Many Requests '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Server error example: type: internal code: internal_error message: Internal server error description: Internal Server Error x-codeSamples: - lang: JavaScript source: >- import Roark from '@roarkanalytics/sdk'; const client = new Roark({ bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted }); const response = await client.simulationRunPlanJob.getCost('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'); console.log(response.data); - lang: Python source: |- import os from roark_analytics import Roark client = Roark( bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"), # This is the default and can be omitted ) response = client.simulation_run_plan_job.get_cost( "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", ) print(response.data) components: schemas: SimulationRunCost: type: object properties: jobId: type: string format: uuid currency: type: string const: usd totalUsdMicros: type: integer description: Total billable spend for the run, in micro-dollars. totalUsd: type: number breakdown: type: array items: $ref: '#/components/schemas/CostBreakdownItem' description: Spend by cost type. Sums to totalUsdMicros. calls: type: array items: $ref: '#/components/schemas/SimulationRunCallCost' description: Spend per simulated call in the run. required: - jobId - currency - totalUsdMicros - totalUsd - breakdown - calls ErrorResponse: type: object properties: type: type: string enum: - validation - authentication - forbidden - not_found - conflict - payment_required - rate_limit - internal description: The error type category examples: - validation - authentication code: type: string description: Machine-readable error code identifier examples: - invalid_parameter - missing_required_field - unauthorized message: type: string description: Human-readable error message examples: - The request was invalid - Authentication required param: type: string description: The parameter that caused the error (if applicable) examples: - email - user_id details: description: Additional error context information required: - type - code - message CostBreakdownItem: type: object properties: source: type: string enum: - SIM_PLATFORM_FEE - SIM_TTS - SIM_STT - SIM_LLM - SIM_TELEPHONY - METRIC - TRANSCRIPTION - INTERNAL_LLM - INTERNAL_STT description: The cost source, e.g. SIM_PLATFORM_FEE, SIM_LLM, METRIC. surface: type: string enum: - SIMULATION - POST_CALL description: SIMULATION or POST_CALL. amountUsdMicros: type: integer description: Billable spend for this type, in micro-dollars. amountUsd: type: number description: The same figure in US dollars. quantity: type: number minimum: 0 description: Units billed (see the line items for the unit). required: - source - surface - amountUsdMicros - amountUsd - quantity SimulationRunCallCost: type: object properties: conversationId: type: - string - 'null' format: uuid description: >- The call (voice runs) or chat (chat runs) the spend is attributed to. Null for costs incurred before the conversation existed; use simulationJobId to join those. simulationJobId: type: - string - 'null' format: uuid amountUsdMicros: type: integer amountUsd: type: number breakdown: type: array items: $ref: '#/components/schemas/CostBreakdownItem' required: - conversationId - simulationJobId - amountUsdMicros - amountUsd - breakdown securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.