OpenapiCaptable
Create options
Grants options to a stakeholder from an equity plan.
POST /v1/captable/options
| Address | https://api.hanzo.ai/v1/captable/options |
| Method | POST |
| Operation | post_captable_options |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Grants options to a stakeholder from an equity plan.
Request
15 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
boardApprovalDate | body | any | — | BoardApprovalDate is when the board approved the grant, YYYY-MM-DD. |
cliffYears | body | any | — | CliffYears is how long before ANY of the grant vests. |
equityPlanId | body | any | — | EquityPlanID is the plan the options come from. |
exercisePrice | body | any | — | ExercisePrice is the strike price per share, in the company's currency. |
expirationDate | body | any | — | ExpirationDate is when unexercised options lapse, YYYY-MM-DD. |
grantId | body | any | — | GrantID is the grant's identifier. |
issueDate | body | any | — | IssueDate is when the grant was made, YYYY-MM-DD. |
notes | body | any | — | Notes is a free-text note kept with the grant. |
quantity | body | any | — | Quantity is how many options to grant. |
rule144Date | body | any | — | Rule144Date is when the Rule 144 holding period starts, YYYY-MM-DD. |
stakeholderId | body | any | — | StakeholderID is who receives the grant. |
status | body | any | — | Status is DRAFT, ACTIVE, EXERCISED, EXPIRED or CANCELLED. |
type | body | any | — | Type is ISO, NSO or RSU. |
vestingStartDate | body | any | — | VestingStartDate is when vesting begins, YYYY-MM-DD. |
vestingYears | body | any | — | VestingYears is the total vesting period. |
Response
| Status | Body | Meaning |
|---|---|---|
201 | captableCreated | created |
201 body — 3 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
id | body | string | — | ID is the created row's id. |
message | body | string | — | Message is the human sentence the cap table wrote, e.g. |
success | body | boolean | — | Success is true when the row was written. |
Failure carries the platform error shape — see Errors.
Examples
hanzo captable options createimport { Configuration, CaptableApi } from 'hanzoai';
const api = new CaptableApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postCaptableOptions({ boardApprovalDate: "<boardApprovalDate>", cliffYears: "<cliffYears>" });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import CaptableApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = CaptableApi(client).post_captable_options(board_approval_date="<boardApprovalDate>", cliff_years="<cliffYears>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.CaptableAPI.PostCaptableOptions(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, captable_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = captable_api::post_captable_options(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CaptableApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new CaptableApi(client).postCaptableOptions();curl -X POST https://api.hanzo.ai/v1/captable/options \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"boardApprovalDate": "<boardApprovalDate>",
"cliffYears": "<cliffYears>"
}'MCP reaches captable through the captable tool, which names its 31 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_captable_classes"
}
}
}'How is this guide?