> ## Documentation Index > Fetch the complete documentation index at: https://developers.circle.com/llms.txt > Use this file to discover all available pages before exploring further. # Deploy a contract from a template > Deploy a smart contract using a template. ## OpenAPI ````yaml openapi/smart-contract-platform.yaml post /v1/w3s/templates/{id}/deploy openapi: 3.0.3 info: description: This is the Circle Contracts API documentation. title: Circle Contracts version: '1.0' servers: - url: https://api.circle.com security: - BearerAuth: [] tags: - name: Templates - name: View / Update - name: Interact - name: Deploy / Import - name: Event Monitors paths: /v1/w3s/templates/{id}/deploy: post: tags: - Templates summary: Deploy a contract from a template description: Deploy a smart contract using a template. operationId: deployContractTemplate parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/XRequestId' requestBody: $ref: '#/components/requestBodies/TemplateContractDeployment' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplateContractDeployment' description: Contract already created in previous request. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' '201': content: application/json: schema: $ref: '#/components/schemas/TemplateContractDeployment' description: New contract deployed. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Error response for the request. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' security: - BearerAuth: [] components: parameters: Id: name: id description: The universally unique identifier of the resource. in: path required: true schema: type: string format: uuid example: b3d9d2d5-4c12-4946-a09d-953e82fae2b0 XRequestId: name: X-Request-Id in: header description: > Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems. schema: $ref: '#/components/schemas/XRequestId' requestBodies: TemplateContractDeployment: content: application/json: schema: title: TemplateContractDeploymentRequest type: object required: - blockchain - entitySecretCiphertext - idempotencyKey - name - walletId properties: idempotencyKey: $ref: '#/components/schemas/IdempotencyKey' blockchain: $ref: '#/components/schemas/Blockchain' walletId: $ref: '#/components/schemas/Id' name: description: Name of the contract in your Circle console. maxLength: 100 minLength: 1 type: string example: My Template Contract description: description: Description of the contract. type: string example: My first template contract deployment! entitySecretCiphertext: $ref: '#/components/schemas/EntitySecretCiphertext' templateParameters: $ref: '#/components/schemas/TemplateParameters' feeLevel: $ref: '#/components/schemas/FeeLevel' gasLimit: $ref: '#/components/schemas/GasLimit' gasPrice: $ref: '#/components/schemas/GasPrice' maxFee: $ref: '#/components/schemas/MaxFee' priorityFee: $ref: '#/components/schemas/PriorityFee' refId: $ref: '#/components/schemas/RefId' description: Deploy contract by template request. required: true schemas: TemplateContractDeployment: title: TemplateContractDeploymentResponse type: object required: - data properties: data: type: object required: - contractIds - transactionId properties: contractIds: type: array description: Unique identifiers of the created smart contracts. items: type: string format: uuid transactionId: description: >- Unique identifier of the pending deployment transaction. transaction. type: string format: uuid Error: title: Error type: object required: - code - message properties: code: type: integer description: Code that corresponds to the error. message: type: string description: Message that describes the error. XRequestId: type: string format: uuid description: >- A unique identifier, which can be helpful for identifying a request when communicating with Circle support. example: 2adba88e-9d63-44bc-b975-9b6ae3440dde IdempotencyKey: type: string description: >- Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. To create a UUIDv4 go to [uuidgenerator.net](https://www.uuidgenerator.net). If the same key is reused, it will be treated as the same request and the original response will be returned. example: a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11 format: uuid Blockchain: type: string description: > The blockchain network that the resource is to be created on or is currently on. Required along with `sourceAddress` if you don't provide `walletId`. The `blockchain` and `walletId` fields are mutually exclusive. enum: - ETH - ETH-SEPOLIA - MATIC - MATIC-AMOY - ARB - ARB-SEPOLIA - UNI - UNI-SEPOLIA - BASE - BASE-SEPOLIA - OP - OP-SEPOLIA - AVAX - AVAX-FUJI - ARC-TESTNET - MONAD - MONAD-TESTNET example: MATIC-AMOY Id: type: string format: uuid description: System-generated unique identifier of the resource. example: c4d1da72-111e-4d52-bdbf-2e74a2d803d5 EntitySecretCiphertext: type: string description: > A base64 string expression of the entity secret ciphertext. The entity secret should be encrypted by the entity public key. Circle mandates that the entity secret ciphertext is unique for each API request. format: byte example: >- M8OAwbJ8rMsPd8+NT4xRDBDJSNqUKAvJeWPyuwZSlVXgRucogAlBxjvjIw4nsKeJ4hejjlpmyaaJrusHm6zsvy4BLuL1an3dYn3wORjYf3sU4QN9Rdk9OJxZvE5hDNPq7okucvb1eElxPVREZvr4ew7sh4ktmwDrwWFUYwKoly4fEzxYI9zvVpCY9xPSgkA5m3u1/P2vMYZ0QFtn8lRZxCuTyc4wRLpT9TOaK46CEXCakmAYaYWnLkl18QXOSY6FhCbGm+zQ2Uu4cUPU/bqjIyQIB80ut3drInDzysQLE/FJjcJW9+q+E75LKGKnrp2zCg/Xv3TEvru9a2A0vd7InZ9kNuxnPPFc1JSO7BT2TPP89YcLO0OmtRiGoXPlYzXuNIfUsVQ5/FW9FPp4qp+iMPrAidsjQrskHPxhW92GeezLpOSkUl7lAWQoioYED979mqGfzNIZTF5Ob6fJifboiwhOab6sAKnxmvWjgFnW/bZ5a8xkzgPc4RHpIejot1Q7fpT+67eA+DVxvUqakJI6t3iEaZTNITCSU2Cfj1oyCQfrZGf9tauW49rO1zYHKoV4z9ylymOWtCUk641iyxwFCNSW47CDsc0M8iI4J6JqsNMpQuR9sdWVhROi5yn9UR7ac7pizB3dFmc0/qjtTRoYStaaSEYg3L5woALv5kAA2j4= TemplateParameters: type: object description: >- JSON object that contains the template deployment parameters used to initialize the contract(s) on-chain. additionalProperties: {} FeeLevel: type: string enum: - LOW - MEDIUM - HIGH example: MEDIUM description: > A dynamic blockchain fee level setting (`LOW`, `MEDIUM`, or `HIGH`) that will be used to pay gas for the transaction. Calculated based on network traffic, supply of validators, and demand for transaction verification. Cannot be used with `gasPrice`, `priorityFee`, or `maxFee`. Estimates for each fee level can be obtained through the [`POST /transactions/transfer/estimateFee`](/api-reference/w3s/developer-controlled-wallets/create-transfer-estimate-fee) API. GasLimit: type: string description: > The maximum units of gas to use for the transaction. Required if `feeLevel` is not provided. Estimates for this limit can be obtained through the [`POST /transactions/transfer/estimateFee`](/api-reference/w3s/developer-controlled-wallets/create-transfer-estimate-fee) API. An insufficient gas limit may cause the transaction to fail on-chain. Use this field with care when manually providing values. GasLimit override (only supported for EOA wallets): Using `gasLimit` together with `feeLevel`, the provided `gasLimit` will override the estimation's gasLimit. example: '21000' GasPrice: type: string description: > For blockchains without EIP-1559 support, the maximum price of gas, in gwei, to use per each unit of gas (see `gasLimit`). Requires `gasLimit`. Cannot be used with `feeLevel`, `priorityFee`, or `maxFee`. Estimates for this fee can be obtained through the [`POST /transactions/transfer/estimateFee`](/api-reference/w3s/developer-controlled-wallets/create-transfer-estimate-fee) API. The wallet service enforces a dynamic minimum `gasPrice` based on current network conditions. Requests specifying a `gasPrice` below this minimum will be rejected MaxFee: type: string example: '5.935224468' description: > For blockchains with EIP-1559 support, the maximum price per unit of gas (see `gasLimit`), in gwei. Requires `priorityFee`, and `gasLimit` to be present. Cannot be used with `feeLevel` or `gasPrice`. Estimates for this fee can be obtained through the [`POST /transactions/transfer/estimateFee`](/api-reference/w3s/developer-controlled-wallets/create-transfer-estimate-fee) API. PriorityFee: type: string example: '1.022783914' description: > For blockchains with EIP-1559 support, the “tip”, in gwei, to add to the base fee as an incentive for validators. Please note that the `maxFee` and `gasLimit` parameters are required alongside the `priorityFee`. The `feeLevel` and `gasPrice` parameters cannot be used with the `priorityFee`. Estimations for this fee can be obtained through the [`POST /transactions/transfer/estimateFee`](/api-reference/w3s/developer-controlled-wallets/create-transfer-estimate-fee) API. The wallet service enforces a dynamic minimum `priorityFee` based on current network conditions. Requests specifying a `priorityFee` below this minimum will be rejected RefId: type: string description: RefID is a custom label field. example: d620d523-b5ab-4541-94b0-efe4f4c825c8 headers: XRequestId: description: > Developer-provided header parameter or Circle-generated universally unique identifier (UUID v4). Useful for identifying a specific request when communicating with Circle Support. schema: $ref: '#/components/schemas/XRequestId' securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: PREFIX:ID:SECRET description: >- Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are required to make a successful request. ````