Build orchestration

cURL

curl --request POST \
  --url https://api.otim.com/orchestration/build \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "completionInstructions": [
    {
      "chainId": 11155111,
      "salt": 1234567890,
      "maxExecutions": 10,
      "actionArguments": {
        "refuelERC20": {
          "token": "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720",
          "target": "0x23618e81E3f5cdF7f54C3d65f7FBc0aBf5B21E8f",
          "threshold": 1000000000000000000,
          "endBalance": 2000000000000000000,
          "fee": {
            "token": "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720",
            "maxBaseFeePerGas": 0,
            "maxPriorityFeePerGas": 15000000000,
            "executionFee": 0
          }
        }
      },
      "setEphemeralTarget": true
    }
  ],
  "instructions": [
    {
      "chainId": 11155111,
      "salt": 1234567890,
      "maxExecutions": 10,
      "actionArguments": {
        "refuelERC20": {
          "token": "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720",
          "target": "0x23618e81E3f5cdF7f54C3d65f7FBc0aBf5B21E8f",
          "threshold": 1000000000000000000,
          "endBalance": 2000000000000000000,
          "fee": {
            "token": "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720",
            "maxBaseFeePerGas": 0,
            "maxPriorityFeePerGas": 15000000000,
            "executionFee": 0
          }
        }
      },
      "setEphemeralTarget": true
    }
  ],
  "metadata": {},
  "payerAddress": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "maxRuns": 123
}
'

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subOrgId": "<string>",
  "walletId": "<string>",
  "ephemeralWalletAddress": "<string>",
  "completionInstructions": [
    {
      "address": "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720",
      "chainId": 11155111,
      "salt": 1234567890,
      "maxExecutions": 10,
      "action": "0x838c90f3e8d4892dCfA67721CbbA7C86D3C059ef",
      "arguments": "0x0000000000000000000000001c7d4b196cb0c7b01d743fbc6116a902379c72380000000000000000000000000a0Ee7A142d267C1f36714E4a8F75612F20a79720000000000000000000000000a0Ee7A142d267C1f36714E4a8F75612F20a79720000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
      "actionName": "sweepDepositERC4626"
    }
  ],
  "instructions": [
    {
      "address": "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720",
      "chainId": 11155111,
      "salt": 1234567890,
      "maxExecutions": 10,
      "action": "0x838c90f3e8d4892dCfA67721CbbA7C86D3C059ef",
      "arguments": "0x0000000000000000000000001c7d4b196cb0c7b01d743fbc6116a902379c72380000000000000000000000000a0Ee7A142d267C1f36714E4a8F75612F20a79720000000000000000000000000a0Ee7A142d267C1f36714E4a8F75612F20a79720000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
      "actionName": "sweepDepositERC4626"
    }
  ]
}

POST

orchestration

build

cURL

curl --request POST \
  --url https://api.otim.com/orchestration/build \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "completionInstructions": [
    {
      "chainId": 11155111,
      "salt": 1234567890,
      "maxExecutions": 10,
      "actionArguments": {
        "refuelERC20": {
          "token": "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720",
          "target": "0x23618e81E3f5cdF7f54C3d65f7FBc0aBf5B21E8f",
          "threshold": 1000000000000000000,
          "endBalance": 2000000000000000000,
          "fee": {
            "token": "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720",
            "maxBaseFeePerGas": 0,
            "maxPriorityFeePerGas": 15000000000,
            "executionFee": 0
          }
        }
      },
      "setEphemeralTarget": true
    }
  ],
  "instructions": [
    {
      "chainId": 11155111,
      "salt": 1234567890,
      "maxExecutions": 10,
      "actionArguments": {
        "refuelERC20": {
          "token": "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720",
          "target": "0x23618e81E3f5cdF7f54C3d65f7FBc0aBf5B21E8f",
          "threshold": 1000000000000000000,
          "endBalance": 2000000000000000000,
          "fee": {
            "token": "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720",
            "maxBaseFeePerGas": 0,
            "maxPriorityFeePerGas": 15000000000,
            "executionFee": 0
          }
        }
      },
      "setEphemeralTarget": true
    }
  ],
  "metadata": {},
  "payerAddress": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "maxRuns": 123
}
'

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subOrgId": "<string>",
  "walletId": "<string>",
  "ephemeralWalletAddress": "<string>",
  "completionInstructions": [
    {
      "address": "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720",
      "chainId": 11155111,
      "salt": 1234567890,
      "maxExecutions": 10,
      "action": "0x838c90f3e8d4892dCfA67721CbbA7C86D3C059ef",
      "arguments": "0x0000000000000000000000001c7d4b196cb0c7b01d743fbc6116a902379c72380000000000000000000000000a0Ee7A142d267C1f36714E4a8F75612F20a79720000000000000000000000000a0Ee7A142d267C1f36714E4a8F75612F20a79720000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
      "actionName": "sweepDepositERC4626"
    }
  ],
  "instructions": [
    {
      "address": "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720",
      "chainId": 11155111,
      "salt": 1234567890,
      "maxExecutions": 10,
      "action": "0x838c90f3e8d4892dCfA67721CbbA7C86D3C059ef",
      "arguments": "0x0000000000000000000000001c7d4b196cb0c7b01d743fbc6116a902379c72380000000000000000000000000a0Ee7A142d267C1f36714E4a8F75612F20a79720000000000000000000000000a0Ee7A142d267C1f36714E4a8F75612F20a79720000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
      "actionName": "sweepDepositERC4626"
    }
  ]
}

Build an orchestration with ephemeral instructions.

Authorizations

Authorization

string

header

required

JWT token for API authentication

Body

application/json

completionInstructions

object[]

required

Instructions to complete the orchestration

Show child attributes

completionInstructions.chainId

integer<uint64>

required

Chain ID

Example:

11155111

completionInstructions.salt

integer<uint256>

required

Salt to ensure instruction is unique

Example:

1234567890

completionInstructions.maxExecutions

integer<uint256>

required

Maximum number of times this instruction can be executed

Example:

10

completionInstructions.actionArguments

RefuelERC20 · object

required

Show child attributes

completionInstructions.actionArguments.refuelERC20

object

required

Show child attributes

completionInstructions.actionArguments.refuelERC20.token

string<address>

required

ERC20 token to refuel the recipient with

Example:

"0xa0Ee7A142d267C1f36714E4a8F75612F20a79720"

completionInstructions.actionArguments.refuelERC20.target

string<address>

required

address of the refuel recipient

Example:

"0x23618e81E3f5cdF7f54C3d65f7FBc0aBf5B21E8f"

completionInstructions.actionArguments.refuelERC20.threshold

integer<uint256>

required

if the balance of the recipient is below this threshold, the refuel will be executed

Example:

1000000000000000000

completionInstructions.actionArguments.refuelERC20.endBalance

integer<uint256>

required

the balance the recipient will have after the refuel is executed

Example:

2000000000000000000

completionInstructions.actionArguments.refuelERC20.fee

object

required

Show child attributes

completionInstructions.actionArguments.refuelERC20.fee.token

string<address>

required

Address of the token used for fee payment

Example:

"0xa0Ee7A142d267C1f36714E4a8F75612F20a79720"

completionInstructions.actionArguments.refuelERC20.fee.maxBaseFeePerGas

integer<uint256>

required

Maximum base fee per gas (in wei, set to 0 to take network base fee at execution time)

Example:

0

completionInstructions.actionArguments.refuelERC20.fee.maxPriorityFeePerGas

integer<uint256>

required

Maximum base fee per gas (in wei)

Example:

15000000000

completionInstructions.actionArguments.refuelERC20.fee.executionFee

integer<uint256>

required

Execution fee (set to 0 since this field isn't being utilized yet)

Example:

0

completionInstructions.setEphemeralTarget

boolean

required

Whether to set the ephemeral account as target for the action arguments

Example:

true

instructions

object[]

required

Instructions to receive the orchestration

Show child attributes

instructions.chainId

integer<uint64>

required

Chain ID

Example:

11155111

instructions.salt

integer<uint256>

required

Salt to ensure instruction is unique

Example:

1234567890

instructions.maxExecutions

integer<uint256>

required

Maximum number of times this instruction can be executed

Example:

10

instructions.actionArguments

RefuelERC20 · object

required

Show child attributes

instructions.actionArguments.refuelERC20

object

required

Show child attributes

instructions.actionArguments.refuelERC20.token

string<address>

required

ERC20 token to refuel the recipient with

Example:

"0xa0Ee7A142d267C1f36714E4a8F75612F20a79720"

instructions.actionArguments.refuelERC20.target

string<address>

required

address of the refuel recipient

Example:

"0x23618e81E3f5cdF7f54C3d65f7FBc0aBf5B21E8f"

instructions.actionArguments.refuelERC20.threshold

integer<uint256>

required

if the balance of the recipient is below this threshold, the refuel will be executed

Example:

1000000000000000000

instructions.actionArguments.refuelERC20.endBalance

integer<uint256>

required

the balance the recipient will have after the refuel is executed

Example:

2000000000000000000

instructions.actionArguments.refuelERC20.fee

object

required

Show child attributes

instructions.actionArguments.refuelERC20.fee.token

string<address>

required

Address of the token used for fee payment

Example:

"0xa0Ee7A142d267C1f36714E4a8F75612F20a79720"

instructions.actionArguments.refuelERC20.fee.maxBaseFeePerGas

integer<uint256>

required

Maximum base fee per gas (in wei, set to 0 to take network base fee at execution time)

Example:

0

instructions.actionArguments.refuelERC20.fee.maxPriorityFeePerGas

integer<uint256>

required

Maximum base fee per gas (in wei)

Example:

15000000000

instructions.actionArguments.refuelERC20.fee.executionFee

integer<uint256>

required

Execution fee (set to 0 since this field isn't being utilized yet)

Example:

0

instructions.setEphemeralTarget

boolean

required

Whether to set the ephemeral account as target for the action arguments

Example:

true

metadata

object

required

Orchestration metadata as arbitrary JSON

payerAddress

string<address> | null

Address of the payer

dueDate

string<date-time> | null

Due date for the orchestration

maxRuns

integer<uint64> | null

Maximum number of times the orchestration can be executed

Response

201 - application/json

Orchestration built successfully

requestId

string<uuid>

required

Orchestration ID

subOrgId

string

required

Turnkey sub-organization ID

walletId

string

required

Turnkey wallet ID

ephemeralWalletAddress

string<address>

required

Ephemeral wallet address

completionInstructions

object[]

required

Completion instructions

Show child attributes

completionInstructions.address

string<address>

required

Address of the user

Example:

"0xa0Ee7A142d267C1f36714E4a8F75612F20a79720"

completionInstructions.chainId

integer<uint64>

required

Chain ID

Example:

11155111

completionInstructions.salt

integer<uint256>

required

Salt to ensure instruction is unique

Example:

1234567890

completionInstructions.maxExecutions

integer<uint256>

required

Maximum number of times this instruction can be executed (0 for unlimited)

Example:

10

completionInstructions.action

string<address>

required

Action contract address

Example:

"0x838c90f3e8d4892dCfA67721CbbA7C86D3C059ef"

completionInstructions.arguments

string<bytes>

required

Arguments to execute on the action contract

Example:

"0x0000000000000000000000001c7d4b196cb0c7b01d743fbc6116a902379c72380000000000000000000000000a0Ee7A142d267C1f36714E4a8F75612F20a79720000000000000000000000000a0Ee7A142d267C1f36714E4a8F75612F20a79720000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"

completionInstructions.actionName

enum<string>

required

Name of the action

Available options:

refuel,

transfer,

refuelERC20,

transferERC20,

uniswapV3ExactInput,

deactivateInstruction,

sweepCCTP,

transferCCTP,

sweep,

sweepERC20,

sweepUniswapV3,

depositERC4626,

sweepDepositERC4626,

withdrawERC4626,

sweepWithdrawERC4626,

callOnce

Example:

"sweepDepositERC4626"

instructions

object[]

required

Instructions

Show child attributes

instructions.address

string<address>

required

Address of the user

Example:

"0xa0Ee7A142d267C1f36714E4a8F75612F20a79720"

instructions.chainId

integer<uint64>

required

Chain ID

Example:

11155111

instructions.salt

integer<uint256>

required

Salt to ensure instruction is unique

Example:

1234567890

instructions.maxExecutions

integer<uint256>

required

Maximum number of times this instruction can be executed (0 for unlimited)

Example:

10

instructions.action

string<address>

required

Action contract address

Example:

"0x838c90f3e8d4892dCfA67721CbbA7C86D3C059ef"

instructions.arguments

string<bytes>

required

Arguments to execute on the action contract

Example:

instructions.actionName

enum<string>

required

Name of the action

Available options:

refuel,

transfer,

refuelERC20,

transferERC20,

uniswapV3ExactInput,

deactivateInstruction,

sweepCCTP,

transferCCTP,

sweep,

sweepERC20,

sweepUniswapV3,

depositERC4626,

sweepDepositERC4626,

withdrawERC4626,

sweepWithdrawERC4626,

callOnce

Example:

"sweepDepositERC4626"

Get ephemeral instruction activity Build settlement orchestration

⌘I

Using the API

Otim APIs

Authorizations

Body

Response