Intent

Submit intent

Submits a create, replace, or cancel command for an account in the caller’s organization. API keys need intent edit permission for the account environment; users need an admin role. Creates require a routable order_venue, resolve the symbol’s instrument, and pass trading controls. Live creates also require live-trading entitlement. Replace and cancel inherit the instrument and strategy; replace cannot change time in force. Authorization, entitlement, and control refusals are recorded for the rejections endpoint.

POST

intents

Submit intent

curl --request POST \
  --url https://api.anthid.com/v1/intents \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "command": {
    "payload": {
      "intent_id": "0199f4d0-7c62-7a4a-9d1e-2b6f5c0a1e33",
      "order_side": "BUY",
      "order_venue": "SMART",
      "spec": {
        "Limit": {
          "price": "215.50",
          "quantity": "10",
          "time_in_force": "DAY"
        }
      },
      "symbol": "AAPL"
    },
    "type": "CREATE"
  },
  "trading_account_id": "550e8400-e29b-41d4-a716-446655440000"
}
'

import requests

url = "https://api.anthid.com/v1/intents"

payload = {
    "command": {
        "payload": {
            "intent_id": "0199f4d0-7c62-7a4a-9d1e-2b6f5c0a1e33",
            "order_side": "BUY",
            "order_venue": "SMART",
            "spec": { "Limit": {
                    "price": "215.50",
                    "quantity": "10",
                    "time_in_force": "DAY"
                } },
            "symbol": "AAPL"
        },
        "type": "CREATE"
    },
    "trading_account_id": "550e8400-e29b-41d4-a716-446655440000"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    command: {
      payload: {
        intent_id: '0199f4d0-7c62-7a4a-9d1e-2b6f5c0a1e33',
        order_side: 'BUY',
        order_venue: 'SMART',
        spec: {Limit: {price: '215.50', quantity: '10', time_in_force: 'DAY'}},
        symbol: 'AAPL'
      },
      type: 'CREATE'
    },
    trading_account_id: '550e8400-e29b-41d4-a716-446655440000'
  })
};

fetch('https://api.anthid.com/v1/intents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.anthid.com/v1/intents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'command' => [
        'payload' => [
                'intent_id' => '0199f4d0-7c62-7a4a-9d1e-2b6f5c0a1e33',
                'order_side' => 'BUY',
                'order_venue' => 'SMART',
                'spec' => [
                                'Limit' => [
                                                                'price' => '215.50',
                                                                'quantity' => '10',
                                                                'time_in_force' => 'DAY'
                                ]
                ],
                'symbol' => 'AAPL'
        ],
        'type' => 'CREATE'
    ],
    'trading_account_id' => '550e8400-e29b-41d4-a716-446655440000'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.anthid.com/v1/intents"

	payload := strings.NewReader("{\n  \"command\": {\n    \"payload\": {\n      \"intent_id\": \"0199f4d0-7c62-7a4a-9d1e-2b6f5c0a1e33\",\n      \"order_side\": \"BUY\",\n      \"order_venue\": \"SMART\",\n      \"spec\": {\n        \"Limit\": {\n          \"price\": \"215.50\",\n          \"quantity\": \"10\",\n          \"time_in_force\": \"DAY\"\n        }\n      },\n      \"symbol\": \"AAPL\"\n    },\n    \"type\": \"CREATE\"\n  },\n  \"trading_account_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.anthid.com/v1/intents")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": {\n    \"payload\": {\n      \"intent_id\": \"0199f4d0-7c62-7a4a-9d1e-2b6f5c0a1e33\",\n      \"order_side\": \"BUY\",\n      \"order_venue\": \"SMART\",\n      \"spec\": {\n        \"Limit\": {\n          \"price\": \"215.50\",\n          \"quantity\": \"10\",\n          \"time_in_force\": \"DAY\"\n        }\n      },\n      \"symbol\": \"AAPL\"\n    },\n    \"type\": \"CREATE\"\n  },\n  \"trading_account_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.anthid.com/v1/intents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"command\": {\n    \"payload\": {\n      \"intent_id\": \"0199f4d0-7c62-7a4a-9d1e-2b6f5c0a1e33\",\n      \"order_side\": \"BUY\",\n      \"order_venue\": \"SMART\",\n      \"spec\": {\n        \"Limit\": {\n          \"price\": \"215.50\",\n          \"quantity\": \"10\",\n          \"time_in_force\": \"DAY\"\n        }\n      },\n      \"symbol\": \"AAPL\"\n    },\n    \"type\": \"CREATE\"\n  },\n  \"trading_account_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}"

response = http.request(request)
puts response.read_body

{
  "intent_id": "550e8400-e29b-41d4-a716-446655440111"
}

"<string>"

"<string>"

"<string>"

"<string>"

"<string>"

"<string>"

<string>

<string>

<string>

"<string>"

Authorizations

x-api-key

string

header

required

Headers

Idempotency-Key

string | null

Optional key, at most 255 bytes, scoped to the organization. Repeating the same request returns its original intent with 201; reusing the key for a different request returns 409. Refused submissions do not consume the key.

Command-Deadline

string | null

Optional RFC 3339 deadline checked after authorization and controls, before writing. An expired deadline returns 412. It does not bound write completion; use POST /v1/intents/void to settle an unanswered keyed command.

Body

application/json

Trading account and command to submit

command

object

required

Requested intent operation and its payload.

Option 1
Option 2
Option 3

Show child attributes

trading_account_id

string<uuid>

required

Trading account that should execute the intent.

Carried in the body rather than the path: submission is a command against the caller's organization, and the account it targets is part of the command.

strategy_id

string<uuid> | null

Optional caller-defined strategy the intent belongs to.

What a strategy is belongs to the caller: one run of a model, one cycle away from a target position and back. The platform never interprets it; it groups by it, so the ledger can report a strategy's executions and PnL across every intent placed under it.

Read on a create. A replace or cancel keeps the strategy of the intent it references: omit it, or repeat the same one. Naming a different strategy is refused with 400.

Response

Intent accepted

intent_id

string<uuid>

required

Submit intent

curl --request POST \
  --url https://api.anthid.com/v1/intents \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "command": {
    "payload": {
      "intent_id": "0199f4d0-7c62-7a4a-9d1e-2b6f5c0a1e33",
      "order_side": "BUY",
      "order_venue": "SMART",
      "spec": {
        "Limit": {
          "price": "215.50",
          "quantity": "10",
          "time_in_force": "DAY"
        }
      },
      "symbol": "AAPL"
    },
    "type": "CREATE"
  },
  "trading_account_id": "550e8400-e29b-41d4-a716-446655440000"
}
'

import requests

url = "https://api.anthid.com/v1/intents"

payload = {
    "command": {
        "payload": {
            "intent_id": "0199f4d0-7c62-7a4a-9d1e-2b6f5c0a1e33",
            "order_side": "BUY",
            "order_venue": "SMART",
            "spec": { "Limit": {
                    "price": "215.50",
                    "quantity": "10",
                    "time_in_force": "DAY"
                } },
            "symbol": "AAPL"
        },
        "type": "CREATE"
    },
    "trading_account_id": "550e8400-e29b-41d4-a716-446655440000"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    command: {
      payload: {
        intent_id: '0199f4d0-7c62-7a4a-9d1e-2b6f5c0a1e33',
        order_side: 'BUY',
        order_venue: 'SMART',
        spec: {Limit: {price: '215.50', quantity: '10', time_in_force: 'DAY'}},
        symbol: 'AAPL'
      },
      type: 'CREATE'
    },
    trading_account_id: '550e8400-e29b-41d4-a716-446655440000'
  })
};

fetch('https://api.anthid.com/v1/intents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.anthid.com/v1/intents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'command' => [
        'payload' => [
                'intent_id' => '0199f4d0-7c62-7a4a-9d1e-2b6f5c0a1e33',
                'order_side' => 'BUY',
                'order_venue' => 'SMART',
                'spec' => [
                                'Limit' => [
                                                                'price' => '215.50',
                                                                'quantity' => '10',
                                                                'time_in_force' => 'DAY'
                                ]
                ],
                'symbol' => 'AAPL'
        ],
        'type' => 'CREATE'
    ],
    'trading_account_id' => '550e8400-e29b-41d4-a716-446655440000'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.anthid.com/v1/intents"

	payload := strings.NewReader("{\n  \"command\": {\n    \"payload\": {\n      \"intent_id\": \"0199f4d0-7c62-7a4a-9d1e-2b6f5c0a1e33\",\n      \"order_side\": \"BUY\",\n      \"order_venue\": \"SMART\",\n      \"spec\": {\n        \"Limit\": {\n          \"price\": \"215.50\",\n          \"quantity\": \"10\",\n          \"time_in_force\": \"DAY\"\n        }\n      },\n      \"symbol\": \"AAPL\"\n    },\n    \"type\": \"CREATE\"\n  },\n  \"trading_account_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.anthid.com/v1/intents")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": {\n    \"payload\": {\n      \"intent_id\": \"0199f4d0-7c62-7a4a-9d1e-2b6f5c0a1e33\",\n      \"order_side\": \"BUY\",\n      \"order_venue\": \"SMART\",\n      \"spec\": {\n        \"Limit\": {\n          \"price\": \"215.50\",\n          \"quantity\": \"10\",\n          \"time_in_force\": \"DAY\"\n        }\n      },\n      \"symbol\": \"AAPL\"\n    },\n    \"type\": \"CREATE\"\n  },\n  \"trading_account_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.anthid.com/v1/intents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"command\": {\n    \"payload\": {\n      \"intent_id\": \"0199f4d0-7c62-7a4a-9d1e-2b6f5c0a1e33\",\n      \"order_side\": \"BUY\",\n      \"order_venue\": \"SMART\",\n      \"spec\": {\n        \"Limit\": {\n          \"price\": \"215.50\",\n          \"quantity\": \"10\",\n          \"time_in_force\": \"DAY\"\n        }\n      },\n      \"symbol\": \"AAPL\"\n    },\n    \"type\": \"CREATE\"\n  },\n  \"trading_account_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}"

response = http.request(request)
puts response.read_body

{
  "intent_id": "550e8400-e29b-41d4-a716-446655440111"
}

"<string>"

"<string>"

"<string>"

"<string>"

"<string>"

"<string>"

<string>

<string>

<string>

"<string>"

Connections

Organizations

Controls

Accounts

Intents

Ledger

Instruments

Stream

MCP

Billing

Submit intent

Authorizations

Headers

Body

Response