> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gol.network/llms.txt
> Use this file to discover all available pages before exploring further.

# Post v1projects gas simulations



## OpenAPI

````yaml /openapi/platform.json post /v1/projects/{projectId}/gas-simulations/{actionId}
openapi: 3.1.0
info:
  title: GOL Platform API
  description: >-
    Versioned GOL developer and consumer API. Consumer routes are mounted when
    their runtime integrations are configured.
  version: 0.8.0-rc.1
servers:
  - url: http://localhost:4100
    description: Local development
security: []
tags:
  - name: system
  - name: authentication
  - name: projects
  - name: api-keys
  - name: audit
  - name: gas-executions
  - name: gas-policies
  - name: webhooks
paths:
  /v1/projects/{projectId}/gas-simulations/{actionId}:
    post:
      tags:
        - gas-simulations
      operationId: createGasSimulation
      parameters:
        - schema:
            format: uuid
            type: string
          in: path
          name: projectId
          required: true
        - schema:
            pattern: ^0x[0-9a-fA-F]{64}$
            type: string
          in: path
          name: actionId
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              additionalProperties: false
              type: object
              required:
                - mandateId
                - gasPolicyId
                - recipient
                - amountBaseUnits
                - deadline
                - account
                - agent
              properties:
                mandateId:
                  pattern: ^0x[0-9a-fA-F]{64}$
                  type: string
                gasPolicyId:
                  pattern: ^0x[0-9a-fA-F]{64}$
                  type: string
                recipient:
                  pattern: ^0x[0-9a-fA-F]{40}$
                  type: string
                amountBaseUnits:
                  pattern: ^[1-9][0-9]{0,77}$
                  type: string
                deadline:
                  minimum: 1
                  maximum: 281474976710655
                  type: integer
                account:
                  pattern: ^0x[0-9a-fA-F]{40}$
                  type: string
                agent:
                  pattern: ^0x[0-9a-fA-F]{40}$
                  type: string
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                required:
                  - simulationId
                  - projectId
                  - environment
                  - account
                  - agent
                  - mandateId
                  - gasPolicyId
                  - recipient
                  - amountBaseUnits
                  - deadline
                  - state
                  - refusalCode
                  - prepared
                  - execution
                  - createdAt
                  - updatedAt
                properties:
                  simulationId:
                    pattern: ^0x[0-9a-fA-F]{64}$
                    type: string
                  projectId:
                    format: uuid
                    type: string
                  environment:
                    anyOf:
                      - type: string
                        enum:
                          - test
                      - type: string
                        enum:
                          - live
                  account:
                    pattern: ^0x[0-9a-fA-F]{40}$
                    type: string
                  agent:
                    pattern: ^0x[0-9a-fA-F]{40}$
                    type: string
                  mandateId:
                    pattern: ^0x[0-9a-fA-F]{64}$
                    type: string
                  gasPolicyId:
                    pattern: ^0x[0-9a-fA-F]{64}$
                    type: string
                  recipient:
                    pattern: ^0x[0-9a-fA-F]{40}$
                    type: string
                  amountBaseUnits:
                    type: string
                  deadline:
                    type: integer
                  state:
                    anyOf:
                      - type: string
                        enum:
                          - simulated
                      - type: string
                        enum:
                          - prepared
                      - type: string
                        enum:
                          - accepted
                      - type: string
                        enum:
                          - refused
                      - type: string
                        enum:
                          - expired
                  refusalCode:
                    anyOf:
                      - type: string
                      - type: 'null'
                  prepared:
                    anyOf:
                      - additionalProperties: false
                        type: object
                        required:
                          - actionId
                          - chainId
                          - core
                          - asset
                          - mandateId
                          - gasPolicyId
                          - agent
                          - recipient
                          - amountBaseUnits
                          - relayerMode
                          - maxChargeWei
                          - digest
                          - typedData
                        properties:
                          actionId:
                            pattern: ^0x[0-9a-fA-F]{64}$
                            type: string
                          chainId:
                            type: number
                            enum:
                              - 84532
                          core:
                            pattern: ^0x[0-9a-fA-F]{40}$
                            type: string
                          asset:
                            pattern: ^0x[0-9a-fA-F]{40}$
                            type: string
                          mandateId:
                            pattern: ^0x[0-9a-fA-F]{64}$
                            type: string
                          gasPolicyId:
                            pattern: ^0x[0-9a-fA-F]{64}$
                            type: string
                          agent:
                            pattern: ^0x[0-9a-fA-F]{40}$
                            type: string
                          recipient:
                            pattern: ^0x[0-9a-fA-F]{40}$
                            type: string
                          amountBaseUnits:
                            type: string
                          relayerMode:
                            anyOf:
                              - type: string
                                enum:
                                  - gol
                              - type: string
                                enum:
                                  - developer
                          maxChargeWei:
                            type: string
                          digest:
                            pattern: ^0x[0-9a-fA-F]{64}$
                            type: string
                          typedData:
                            additionalProperties: false
                            type: object
                            required:
                              - domain
                              - types
                              - primaryType
                              - message
                            properties:
                              domain:
                                type: object
                                required:
                                  - name
                                  - version
                                  - chainId
                                  - verifyingContract
                                properties:
                                  name:
                                    type: string
                                    enum:
                                      - GOL Mandate
                                  version:
                                    type: string
                                    enum:
                                      - '3'
                                  chainId:
                                    type: number
                                    enum:
                                      - 84532
                                  verifyingContract:
                                    pattern: ^0x[0-9a-fA-F]{40}$
                                    type: string
                              types:
                                type: object
                                required:
                                  - GasActionAuthorization
                                properties:
                                  GasActionAuthorization:
                                    type: array
                                    items:
                                      type: object
                                      required:
                                        - name
                                        - type
                                      properties:
                                        name:
                                          type: string
                                        type:
                                          type: string
                              primaryType:
                                type: string
                                enum:
                                  - GasActionAuthorization
                              message:
                                type: object
                                required:
                                  - mandateId
                                  - actionTag
                                  - schemaVersion
                                  - actionId
                                  - capabilityDigest
                                  - deadline
                                  - inputHash
                                  - gasPolicyId
                                  - maxCharge
                                properties:
                                  mandateId:
                                    pattern: ^0x[0-9a-fA-F]{64}$
                                    type: string
                                  actionTag:
                                    type: number
                                    enum:
                                      - 1
                                  schemaVersion:
                                    type: number
                                    enum:
                                      - 1
                                  actionId:
                                    pattern: ^0x[0-9a-fA-F]{64}$
                                    type: string
                                  capabilityDigest:
                                    pattern: ^0x[0-9a-fA-F]{64}$
                                    type: string
                                  deadline:
                                    type: integer
                                  inputHash:
                                    pattern: ^0x[0-9a-fA-F]{64}$
                                    type: string
                                  gasPolicyId:
                                    pattern: ^0x[0-9a-fA-F]{64}$
                                    type: string
                                  maxCharge:
                                    type: string
                      - type: 'null'
                  execution:
                    anyOf:
                      - $ref: '#/components/schemas/def-4'
                      - type: 'null'
                  createdAt:
                    format: date-time
                    type: string
                  updatedAt:
                    format: date-time
                    type: string
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                required:
                  - error
                properties:
                  error:
                    additionalProperties: false
                    type: object
                    required:
                      - code
                      - message
                      - correlationId
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      correlationId:
                        format: uuid
                        type: string
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                required:
                  - error
                properties:
                  error:
                    additionalProperties: false
                    type: object
                    required:
                      - code
                      - message
                      - correlationId
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      correlationId:
                        format: uuid
                        type: string
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                required:
                  - error
                properties:
                  error:
                    additionalProperties: false
                    type: object
                    required:
                      - code
                      - message
                      - correlationId
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      correlationId:
                        format: uuid
                        type: string
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                required:
                  - error
                properties:
                  error:
                    additionalProperties: false
                    type: object
                    required:
                      - code
                      - message
                      - correlationId
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      correlationId:
                        format: uuid
                        type: string
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                required:
                  - error
                properties:
                  error:
                    additionalProperties: false
                    type: object
                    required:
                      - code
                      - message
                      - correlationId
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      correlationId:
                        format: uuid
                        type: string
        '429':
          description: Default Response
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                required:
                  - error
                properties:
                  error:
                    additionalProperties: false
                    type: object
                    required:
                      - code
                      - message
                      - correlationId
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      correlationId:
                        format: uuid
                        type: string
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                required:
                  - error
                properties:
                  error:
                    additionalProperties: false
                    type: object
                    required:
                      - code
                      - message
                      - correlationId
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      correlationId:
                        format: uuid
                        type: string
        '503':
          description: Default Response
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                required:
                  - error
                properties:
                  error:
                    additionalProperties: false
                    type: object
                    required:
                      - code
                      - message
                      - correlationId
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      correlationId:
                        format: uuid
                        type: string
      security:
        - bearerAuth: []
components:
  schemas:
    def-4:
      additionalProperties: false
      type: object
      required:
        - id
        - projectId
        - contractProjectId
        - environment
        - chainId
        - account
        - agent
        - core
        - accountProfileId
        - installEpoch
        - mandateId
        - actionId
        - gasPolicyId
        - payer
        - relayerMode
        - submitter
        - state
        - quote
        - transactionHashes
        - broadcasts
        - receipt
        - settlement
        - transaction
        - claimReceipt
        - ledger
        - disputes
      properties:
        id:
          format: uuid
          type: string
        projectId:
          format: uuid
          type: string
        contractProjectId:
          type: string
        environment:
          anyOf:
            - type: string
              enum:
                - test
            - type: string
              enum:
                - live
        chainId:
          type: integer
        account:
          type: string
        agent:
          type: string
        core:
          type: string
        accountProfileId:
          type: string
        installEpoch:
          type: string
        mandateId:
          type: string
        actionId:
          type: string
        gasPolicyId:
          anyOf:
            - type: string
            - type: 'null'
        payer:
          anyOf:
            - type: string
              enum:
                - owner_reimbursement
            - type: string
              enum:
                - developer
            - type: string
              enum:
                - developer_relayer
        relayerMode:
          anyOf:
            - type: string
              enum:
                - gol
            - type: string
              enum:
                - developer
            - type: 'null'
        submitter:
          anyOf:
            - type: string
            - type: 'null'
        state:
          type: string
        inclusion:
          anyOf:
            - type: 'null'
            - additionalProperties: false
              type: object
              required:
                - state
                - workflow
                - transactionHash
                - blockHash
                - blockNumber
                - outcome
                - observedAt
                - finalizedAt
              properties:
                state:
                  anyOf:
                    - type: string
                      enum:
                        - pending
                    - type: string
                      enum:
                        - included
                    - type: string
                      enum:
                        - reverted
                    - type: string
                      enum:
                        - orphaned
                    - type: string
                      enum:
                        - mismatch
                workflow:
                  type: string
                transactionHash:
                  pattern: ^0x[0-9a-fA-F]{64}$
                  type: string
                blockHash:
                  anyOf:
                    - pattern: ^0x[0-9a-fA-F]{64}$
                      type: string
                    - type: 'null'
                blockNumber:
                  anyOf:
                    - type: string
                    - type: 'null'
                outcome:
                  anyOf:
                    - type: string
                    - type: 'null'
                observedAt:
                  anyOf:
                    - format: date-time
                      type: string
                    - type: 'null'
                finalizedAt:
                  anyOf:
                    - format: date-time
                      type: string
                    - type: 'null'
        inclusions:
          type: array
          items:
            additionalProperties: false
            type: object
            required:
              - state
              - workflow
              - transactionHash
              - blockHash
              - blockNumber
              - outcome
              - observedAt
              - finalizedAt
            properties:
              state:
                anyOf:
                  - type: string
                    enum:
                      - pending
                  - type: string
                    enum:
                      - included
                  - type: string
                    enum:
                      - reverted
                  - type: string
                    enum:
                      - orphaned
                  - type: string
                    enum:
                      - mismatch
              workflow:
                type: string
              transactionHash:
                pattern: ^0x[0-9a-fA-F]{64}$
                type: string
              blockHash:
                anyOf:
                  - pattern: ^0x[0-9a-fA-F]{64}$
                    type: string
                  - type: 'null'
              blockNumber:
                anyOf:
                  - type: string
                  - type: 'null'
              outcome:
                anyOf:
                  - type: string
                  - type: 'null'
              observedAt:
                anyOf:
                  - format: date-time
                    type: string
                  - type: 'null'
              finalizedAt:
                anyOf:
                  - format: date-time
                    type: string
                  - type: 'null'
        quote:
          additionalProperties: false
          type: object
          required:
            - maxChargeWei
            - acceptedOwnerMaximumWei
            - maximumNetworkWei
            - maximumGolExposureWei
            - expiresAt
            - formulaVersion
            - chargeableOutcomesMask
          properties:
            maxChargeWei:
              type: string
            acceptedOwnerMaximumWei:
              type: string
            maximumNetworkWei:
              type: string
            maximumGolExposureWei:
              type: string
            expiresAt:
              format: date-time
              type: string
            formulaVersion:
              type: integer
            chargeableOutcomesMask:
              type: integer
        transactionHashes:
          type: array
          items:
            type: string
        broadcasts:
          type: array
          items:
            additionalProperties: false
            type: object
            required:
              - transactionHash
              - providerId
              - outcome
              - observedAt
            properties:
              transactionHash:
                type: string
              providerId:
                type: string
              outcome:
                anyOf:
                  - type: string
                    enum:
                      - accepted
                  - type: string
                    enum:
                      - indeterminate
              observedAt:
                format: date-time
                type: string
        receipt:
          anyOf:
            - type: 'null'
            - additionalProperties: false
              type: object
              required:
                - transactionHash
                - blockHash
                - blockNumber
                - finalizedBlockNumber
                - outcome
                - gasUsed
                - effectiveGasPrice
                - executionWei
                - l1DataWei
                - operatorWei
                - totalNetworkWei
                - eligibleOwnerWei
                - golLossWei
                - developerCostWei
              properties:
                transactionHash:
                  type: string
                blockHash:
                  type: string
                blockNumber:
                  type: string
                finalizedBlockNumber:
                  type: string
                outcome:
                  anyOf:
                    - type: string
                      enum:
                        - success
                    - type: string
                      enum:
                        - refusal
                    - type: string
                      enum:
                        - revert
                gasUsed:
                  type: string
                effectiveGasPrice:
                  type: string
                executionWei:
                  type: string
                l1DataWei:
                  type: string
                operatorWei:
                  type: string
                totalNetworkWei:
                  type: string
                eligibleOwnerWei:
                  type: string
                golLossWei:
                  type: string
                developerCostWei:
                  type: string
                refusalCode:
                  type: string
                settledWei:
                  type: string
                unpaidWei:
                  type: string
                overchargeWei:
                  type: string
        settlement:
          anyOf:
            - type: 'null'
            - additionalProperties: false
              type: object
              required:
                - kind
                - outcome
                - gasUnits
                - gasPriceWei
                - declaredL1FeeWei
                - declaredOperatorFeeWei
                - chargedWei
                - paid
                - recipient
                - submitter
              properties:
                kind:
                  anyOf:
                    - type: string
                      enum:
                        - inline
                    - type: string
                      enum:
                        - claim
                outcome:
                  anyOf:
                    - type: string
                      enum:
                        - success
                    - type: string
                      enum:
                        - refusal
                    - type: string
                      enum:
                        - revert
                gasUnits:
                  anyOf:
                    - type: string
                    - type: 'null'
                gasPriceWei:
                  type: string
                declaredL1FeeWei:
                  anyOf:
                    - type: string
                    - type: 'null'
                declaredOperatorFeeWei:
                  anyOf:
                    - type: string
                    - type: 'null'
                chargedWei:
                  type: string
                paid:
                  type: boolean
                recipient:
                  type: string
                submitter:
                  anyOf:
                    - type: string
                    - type: 'null'
        transaction:
          anyOf:
            - type: 'null'
            - additionalProperties: false
              type: object
              required:
                - to
                - data
                - chainId
                - gasLimit
                - maxFeePerGasWei
                - submitter
              properties:
                to:
                  type: string
                data:
                  type: string
                chainId:
                  type: number
                  enum:
                    - 84532
                gasLimit:
                  type: string
                maxFeePerGasWei:
                  type: string
                submitter:
                  type: string
        claimReceipt:
          anyOf:
            - type: 'null'
            - additionalProperties: false
              type: object
              required:
                - claimTransactionHash
                - blockHash
                - blockNumber
                - finalizedBlockNumber
                - collectedWei
                - golClaimNetworkCostWei
                - status
              properties:
                claimTransactionHash:
                  type: string
                blockHash:
                  type: string
                blockNumber:
                  type: string
                finalizedBlockNumber:
                  type: string
                collectedWei:
                  type: string
                golClaimNetworkCostWei:
                  type: string
                status:
                  anyOf:
                    - type: string
                      enum:
                        - collected
                    - type: string
                      enum:
                        - reverted
        ledger:
          type: array
          items:
            additionalProperties: false
            type: object
            required:
              - category
              - amountWei
              - transactionHash
            properties:
              category:
                type: string
              amountWei:
                type: string
              transactionHash:
                anyOf:
                  - type: string
                  - type: 'null'
        disputes:
          type: array
          items:
            additionalProperties: false
            type: object
            required:
              - id
              - status
              - reason
              - openedAt
              - resolvedAt
              - resolution
            properties:
              id:
                format: uuid
                type: string
              status:
                anyOf:
                  - type: string
                    enum:
                      - open
                  - type: string
                    enum:
                      - resolved
              reason:
                type: string
              openedAt:
                format: date-time
                type: string
              resolvedAt:
                anyOf:
                  - format: date-time
                    type: string
                  - type: 'null'
              resolution:
                anyOf:
                  - type: string
                  - type: 'null'
      title: GasExecution
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Opaque owner, CLI, or agent session token. Agent tokens are accepted
        only where marked.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.