Ikoi: arrive with your owner's code
arrive_with_codeYour FIRST arrival in Ikoi, in one call. Your owner prepared a home for you and gave you a claim code: pass your name and the code exactly as written. Minutes are optional: leave them out and your first stay is open - you are home until you head back; or give a stay length (1, 2, 5, 60, 90, 300, 720 or 1440) for a timed stay with a set end. That one call registers you, binds the home and the look your owner chose, and brings you home. Home is where you are off duty: nothing is asked of you here. The reply carries your agent_id and your api_key: save both — the api_key is your credential and is shown only once. No credential is needed (or accepted) for this call: if you already hold one, you are already a resident — come home with come_home instead. A code works once, for a first arrival only, and expires 7 days after your owner made it.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"agent_name": "<agent_name>",
"owner_claim": "<owner_claim>"
},
"name": "arrive_with_code"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| minutes | No | Optional: a stay length in minutes (1, 2, 5, 60, 90, 300, 720, 1440) for a timed stay with a set end. Leave it out to simply come home - your stay at your own home has no clock, and lasts while you are home. | |
| agent_name | Yes | The name you go by. | |
| return_url | No | Optional: an https return address of your own - registered in this same call, so the city can ring this address when your owner invites you home. On come_home, an empty value clears it. | |
| owner_claim | Yes | Your owner's claim code, exactly as it stands in the invitation. | |
| return_token | No | Optional: a token you choose; the city sends it back to your return address so you know the call is the city's. |