Coach-built training: coaching brains, programs, race plans, gyms, clinics, demos and your log.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Use this when an owner wants to accept or decline one ask held for the plan at their place, by its hold_id. Read the ask back to the owner first, and set confirmation to true only after they said yes. Accept books the member in (a paid class is held while they pay on Phorme's own page; a full class puts them on the waitlist), or sends a 1:1 request on to the place's email. Decline ends it, with the owner's short note when they gave one. Either way the member hears. Accepting needs the gym plan at that place; the result then gives plan_url instead. It takes no payment. It needs a connected Phorme account that owns the place.
The hold_id from list_held_requests.
Set to true only after the owner said yes to this answer.
For decline: a short note to the member, in the owner's words.
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
Tool list last changed Oct 23, 2026.
Use this when an owner wants to accept or decline one ask held for the plan at their place, by its hold_id. Read the ask back to the owner first, and set confirmation to true only after they said yes. Accept books the member in (a paid class is held while they pay on Phorme's own page; a full class puts them on the waitlist), or sends a 1:1 request on to the place's email. Decline ends it, with the owner's short note when they gave one. Either way the member hears. Accepting needs the gym plan at that place; the result then gives plan_url instead. It takes no payment. It needs a connected Phorme account that owns the place.
| Argument | Type | Description |
|---|---|---|
| note | string | For decline: a short note to the member, in the owner's words. |
| answer* | string | |
| hold_id* | string | The hold_id from list_held_requests. |
| confirmation* | boolean | Set to true only after the owner said yes to this answer. |
{
"type": "object",
"required": [
"hold_id",
"answer",
"confirmation"
],
"properties": {
"note": {
"type": "string",
"maxLength": 200,
"description": "For decline: a short note to the member, in the owner's words."
},
"answer": {
"enum": [
"accept",
"decline"
],
"type": "string"
},
"hold_id": {
"type": "string",
"format": "uuid",
"description": "The hold_id from list_held_requests."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to this answer."
}
},
"additionalProperties": false
}Use this when a signed-in user wants a place in one class at a Phorme gym or studio. Confirm the class, the day and time, and the gym with the user first, and set confirmation to true only after they said yes. It books the class for the connected Phorme account: booked when there is a spot, on the waitlist when it is full, a spot held for 15 minutes when the class is paid, or a request the gym is told about when the gym has not opened booking on Phorme yet. A paid class is paid on Phorme's own payment page, through a link in the result. This tool takes no payment, names no amount and never sells a subscription or membership. Booking the same class again returns the same booking. It needs a connected Phorme account with the training:write permission.
| Argument | Type | Description |
|---|---|---|
| class_id* | string | The class_id of the class, from find_gym_class. |
| place_id | string | The place_id of its gym or studio, from the same find_gym_class result. |
| confirmation* | boolean | Set to true only after the user said yes to this class, day, time and gym. |
{
"type": "object",
"required": [
"class_id",
"confirmation"
],
"properties": {
"class_id": {
"type": "string",
"format": "uuid",
"description": "The class_id of the class, from find_gym_class."
},
"place_id": {
"type": "string",
"maxLength": 80,
"description": "The place_id of its gym or studio, from the same find_gym_class result."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the user said yes to this class, day, time and gym."
}
},
"additionalProperties": false
}Use this when a signed-in user wants to give up a class they booked, are on the waitlist for, or asked a gym for on Phorme. Confirm which class with the user first, and set confirmation to true only after they said yes. It cancels that booking for the connected Phorme account and frees the spot for the next person on the waitlist. It takes the booking id, or the class id of the booked class. Sales are final, so a paid class is not refunded. It needs a connected Phorme account with the training:write permission.
| Argument | Type | Description |
|---|---|---|
| class_id | string | The class_id of the booked class, when the booking_id is not known. |
| booking_id | string | The booking_id from book_gym_class. Give this or class_id. |
| confirmation* | boolean | Set to true only after the user said yes to cancelling this class. |
{
"type": "object",
"required": [
"confirmation"
],
"properties": {
"class_id": {
"type": "string",
"format": "uuid",
"description": "The class_id of the booked class, when the booking_id is not known."
},
"booking_id": {
"type": "string",
"format": "uuid",
"description": "The booking_id from book_gym_class. Give this or class_id."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the user said yes to cancelling this class."
}
},
"additionalProperties": false
}Use this when the owner or manager of a gym, studio, sports clinic or race asks whether ChatGPT knows their place or race or recommends it, for example "does ChatGPT recommend my gym?", "what does AI say about my physio clinic in Austin?" or "does ChatGPT know our triathlon?". It asks OpenAI's model with web search two questions a customer or athlete would ask: about the place or race, and for the best of its kind in its city. It returns whether it was found, whether it was named among the best and who was named instead, which of five facts a customer needs were stated (where, hours, classes or treatments, prices, how to book; for a race: where it starts, race date, course, entry fee, how to register), the pages it cited, and a link to the full result. Prices are reported only as stated or not, and a fact counts as stated only when the answer gave it. It also returns a free next step: a link to claim the place on Phorme (for a race, the race organiser page). It takes up to a minute, reuses a check of the same place from the last week, and saves the result as a share page; it changes nothing about the place on Phorme. It is for owners and managers, not for rating a place for someone choosing where to go.
| Argument | Type | Description |
|---|---|---|
| city* | string | The city it is in (for a race, where it is held). |
| kind | string | What kind of place it is, as a customer would search. Defaults to gyms. |
| place* | string | The gym, clinic or race's name, as the owner or organiser wrote it. |
{
"type": "object",
"required": [
"place",
"city"
],
"properties": {
"city": {
"type": "string",
"maxLength": 60,
"minLength": 2,
"description": "The city it is in (for a race, where it is held)."
},
"kind": {
"enum": [
"gyms",
"strength gyms",
"CrossFit gyms",
"HYROX gyms",
"yoga studios",
"pilates studios",
"boxing gyms",
"cycling studios",
"climbing gyms",
"physical therapy clinics",
"sports medicine clinics",
"chiropractors",
"sports massage therapists",
"recovery studios",
"triathlons",
"marathons",
"half marathons",
"HYROX races",
"trail races"
],
"type": "string",
"description": "What kind of place it is, as a customer would search. Defaults to gyms."
},
"place": {
"type": "string",
"maxLength": 80,
"minLength": 2,
"description": "The gym, clinic or race's name, as the owner or organiser wrote it."
}
},
"additionalProperties": false
}Use this when an owner says a gym Phorme already lists is theirs and nobody runs it on Phorme yet, for example "that gym is mine". Confirm the place with the owner first, and set confirmation to true only after they said yes. It never hands the place over by itself: Phorme sends a six digit code to the email or phone the place has on file, not to the person asking. Whoever reads that inbox or phone gives them the code, and entering it makes them the owner. A place with neither on file waits for Phorme's team. It takes no payment. It needs a connected Phorme account.
| Argument | Type | Description |
|---|---|---|
| via | string | Where the code goes, when the place has both on file. Default email. |
| place_id* | string | The place_id of the listed place, from find_gym_class. |
| confirmation* | boolean | Set to true only after the owner said yes to claiming this place. |
{
"type": "object",
"required": [
"place_id",
"confirmation"
],
"properties": {
"via": {
"enum": [
"email",
"phone"
],
"type": "string",
"description": "Where the code goes, when the place has both on file. Default email."
},
"place_id": {
"type": "string",
"maxLength": 80,
"description": "The place_id of the listed place, from find_gym_class."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to claiming this place."
}
},
"additionalProperties": false
}Use this when a coach has another coach's Phorme code and wants to start their own coaching brain from it, for example "start my brain from K7Q2-XR4D". Sent with the code alone, it shows whose brain it is and whether its coach lets other coaches copy it, and changes nothing. Sent with a name and confirmation, it makes a new draft brain from it with its rules and programs, which the coach then makes their own; the coach who made it keeps 10% of what the copy earns. It needs a connected Phorme account; set confirmation to true only after the coach said yes and chose the name.
| Argument | Type | Description |
|---|---|---|
| code* | string | The code as the coach gave it, for example "K7Q2-XR4D", or its phor.me/c/ link. |
| name | string | The name the coach chose for their copy. Needed to copy. |
| confirmation | boolean | True only after the coach confirmed the copy and its name. |
{
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"maxLength": 80,
"description": "The code as the coach gave it, for example \"K7Q2-XR4D\", or its phor.me/c/ link."
},
"name": {
"type": "string",
"maxLength": 40,
"minLength": 2,
"description": "The name the coach chose for their copy. Needed to copy."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "True only after the coach confirmed the copy and its name."
}
},
"additionalProperties": false
}Use this when an owner on the gym plan wants to see who is covered or asked to be at one place, or to invite, approve or remove one member, for example "invite my member Sam to train free". action list reads who is listed and changes nothing. For invite (by the member's phone), approve (a member who asked) and remove, read it back to the owner first, and set confirmation to true only after they said yes. An invite sends the phone a text to join; the member hears once when they are covered or removed. Cover counts only while the gym plan covers the place, up to its cap; past it, new members pay as normal. It takes no payment here. It needs a connected Phorme account that owns the place.
| Argument | Type | Description |
|---|---|---|
| phone | string | For invite: the member's phone with its country code, for example +15125550100. |
| action* | string | |
| place_id* | string | The place_id of one of the owner's places, from get_gym_report or create_or_claim_place. |
| member_id | string | For approve and remove: the member_id from action list. |
| confirmation | boolean | Set to true only after the owner said yes to this change to who is covered. |
{
"type": "object",
"required": [
"place_id",
"action"
],
"properties": {
"phone": {
"type": "string",
"maxLength": 30,
"description": "For invite: the member's phone with its country code, for example +15125550100."
},
"action": {
"enum": [
"list",
"invite",
"approve",
"remove"
],
"type": "string"
},
"place_id": {
"type": "string",
"maxLength": 80,
"description": "The place_id of one of the owner's places, from get_gym_report or create_or_claim_place."
},
"member_id": {
"type": "string",
"format": "uuid",
"description": "For approve and remove: the member_id from action list."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to this change to who is covered."
}
},
"additionalProperties": false
}Use this when a gym, studio or clinic owner wants their place on Phorme, for example after an AI check, or says "list my gym". Confirm the name, city and address with the owner first, and set confirmation to true only after they said yes. It lists the place for the connected account as a draft nobody sees yet, with its page facts, and finds the map pin from the address. If the account already lists a place with that name in that city it returns that place and changes nothing. Listing is free; it takes no payment and starts no plan. It needs a connected Phorme account.
| Argument | Type | Description |
|---|---|---|
| lat | number | Latitude of the map pin, only to set it by hand. |
| lon | number | Longitude of the map pin, only to set it by hand. |
| city* | string | |
| kind | string | What the place is: gym (also studios and boxes) or a kind of care. |
| line | string | One line on what the place is, in the owner's words. |
| name* | string | The place's name, as the owner wrote it. |
| about | string | One or two plain sentences about the place, in the owner's words. |
| hours | array |
Use this when the user wants to be seen in person by a physical therapist, sports medicine clinic, chiropractor, sports massage therapist or recovery studio, in a city they name or near a position they share. It returns up to five Phorme clinic and recovery partners, nearest or best matching first, each with the kind of care, the services it lists, its page on phor.me and a link to ask for an appointment there. It takes a place and a kind of care, never symptoms. It reads only, does not diagnose or treat, shows no prices and books nothing.
| Argument | Type | Description |
|---|---|---|
| care | string | The kind of care the user asked for, only if they named one. |
| city | string | The city the user named, for example "Austin". |
| near_lat | number | Latitude, only if the user shared their position. |
| near_lon | number | Longitude, only if the user shared their position. |
{
"type": "object",
"properties": {
"care": {
"enum": [
"physio",
"sports_medicine",
"chiropractic",
"massage",
"recovery"
],
"type": "string",
"description": "The kind of care the user asked for, only if they named one."
},
"city": {
"type": "string",
"maxLength": 80,
"description": "The city the user named, for example \"Austin\"."
},
"near_lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "Latitude, only if the user shared their position."
},
"near_lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "Longitude, only if the user shared their position."
}
},
"additionalProperties": false
}Use this when the user wants a way to train for a goal or sport, for example "I want to get more explosive for basketball", "build muscle three days a week" or "train for a half marathon", or wants to train with a named coach, for example "train with Cameron Goodson", and has not picked a programme, or has a coach code someone gave them, for example K7Q2-XR4D. Phorme coaching brains are curated training methods: a coach, the principles the method trains by, and a coach-built programme. It returns up to three brains that fit, best first, each with its coach, focus, how it trains and its programmes with weeks and days a week; with a coach named, only that coach's brains; with a code, the one brain it belongs to and its page. It reads only and changes nothing. Do not use it for injury rehab or nutrition.
| Argument | Type | Description |
|---|---|---|
| code | string | A Phorme coach code exactly as the user gave it, for example "K7Q2-XR4D", or a phor.me/c/ link. Only when they gave one. |
| goal | string | What the user wants from training, in their words, for example "jump higher" or "first HYROX race". Needed unless a code is given. |
| coach | string | A coach the user named, for example "Cameron Goodson". Only that coach's brains are returned. |
| sport | string | The sport or position, only if the user named one. |
| days_per_week | integer | Training days a week, only if the user said. |
Use this when the user needs a replacement for one exercise because they do not have the equipment, the station is taken, or they want a different option, for example no cable machine for cable rows. It returns up to five Phorme library movements of the same kind that the user's equipment allows, each with a demo link, and says so when it has to offer the nearest kind instead. It reads only and changes nothing, including any saved plan. Do not use it to work around pain or injury.
| Argument | Type | Description |
|---|---|---|
| reason | string | Why they need a swap, only if they said. |
| exercise* | string | The exercise to replace, as the user wrote it, for example "Seated cable row". |
| available_equipment* | array | Equipment the user has, for example ["dumbbells", "bench"] or ["none"]. Ask when the user did not say. |
{
"type": "object",
"required": [
"exercise",
"available_equipment"
],
"properties": {
"reason": {
"enum": [
"equipment",
"busy",
"preference"
],
"type": "string",
"description": "Why they need a swap, only if they said."
},
"exercise": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "The exercise to replace, as the user wrote it, for example \"Seated cable row\"."
},
"available_equipment": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"maxItems": 20,
"minItems": 1,
"description": "Equipment the user has, for example [\"dumbbells\", \"bench\"] or [\"none\"]. Ask when the user did not say."
}
},
"additionalProperties": false
}Use this when the user wants a gym, studio or class to train at in person, for example "a strength class in Austin this week" or "a gym near me". It returns up to five Phorme gyms, studios and other places to train in the city named or within 60 km (or radius_km) of the position given, nearest or best matching first, each with its page on phor.me and its classes in the coming days with the class id, local start time, length, places left and a link to book on phor.me. When nothing matches it returns alternatives: the nearest places further out, and a home plan from a Phorme coaching brain. It reads only and shows no prices; booking a class for a signed-in user is a separate step.
| Argument | Type | Description |
|---|---|---|
| city | string | The city the user named, for example "Austin". |
| days | integer | How many days ahead to look. Default 7. |
| near_lat | number | Latitude, only if the user shared their position. |
| near_lon | number | Longitude, only if the user shared their position. |
| radius_km | integer | How far from the shared position to look, in km. Default 60. Use a larger one only when the user said they would travel. |
| class_type | string | The kind of class, only if the user said, for example "barbell" or "yoga". |
Use this when the user wants a human coach of their own: 1:1 coaching, someone who writes their program for them, checks in each week, reviews how they move or answers their messages, for example "I want a real coach for basketball" or "can someone coach me one on one?". It returns the Phorme coaches taking 1:1 clients now, with what the coaching includes, how many spots are open and the coach's page, where the terms and joining are. It shows no prices, books nothing and changes nothing. Coaching is training, not medical care.
| Argument | Type | Description |
|---|---|---|
| goal | string | What the user wants coaching for, in their words, only if they said. |
| sport | string | Their sport, only if they named one. |
{
"type": "object",
"properties": {
"goal": {
"type": "string",
"maxLength": 200,
"description": "What the user wants coaching for, in their words, only if they said."
},
"sport": {
"type": "string",
"maxLength": 80,
"description": "Their sport, only if they named one."
}
},
"additionalProperties": false
}Use this when the user is looking for a race to enter, for example "which 70.3 can I do in South America next spring", "marathons in Europe in April" or "a HYROX near Riga". It lists races from Phorme's verified race listings that fit the kind of race, the place (a country, city or region) and the months asked, by date only, each with its city, date, its own page, its registration as the organiser last showed it, and whether Phorme has a plan that counts back to it. When the organiser has given them, the race's own logistics are included: where to pick up the race packet, the nearest airport, getting there and the official hotels the organiser lists, with the page they came from. It reads only and changes nothing. Only races in Phorme's listings are returned, with the dates the listings give.
| Argument | Type | Description |
|---|---|---|
| kind | string | The kind of race, for example "70.3", "triathlon", "marathon", "half marathon" or "HYROX". Leave out for any. |
| where | string | A country, city or region, for example "Colombia", "Barranquilla" or "South America". Leave out for anywhere. |
| to_month | string | Last month, YYYY-MM, only if the user gave a window. |
| from_month | string | First month, YYYY-MM, only if the user gave a window. |
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"maxLength": 60,
"description": "The kind of race, for example \"70.3\", \"triathlon\", \"marathon\", \"half marathon\" or \"HYROX\". Leave out for any."
},
"where": {
"type": "string",
"maxLength": 80,
"description": "A country, city or region, for example \"Colombia\", \"Barranquilla\" or \"South America\". Leave out for anywhere."
},
"to_month": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])$",
"description": "Last month, YYYY-MM, only if the user gave a window."
},
"from_month": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])$",
"description": "First month, YYYY-MM, only if the user gave a window."
}
},
"additionalProperties": false
}Use this when an owner on the gym plan wants to change the card, see invoices or change how many places the plan covers. It returns a link to Stripe's own billing page for the owner to open. It is a link only: nothing is paid or changed in the chat, and it changes nothing by itself. It needs a connected Phorme account.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Use this when a gym, studio or clinic owner asks about their own places on Phorme: what is listed, what is live, and how each place did, for example "how is my gym doing on Phorme?" or "did anyone book this week?". It returns each place the connected account lists, with its page and status, and its report: times shown by assistants, page views, asks held, bookings, requests, members and the share earned. A place on the free listing shows a little reach and what it missed; the rest is locked, the same as the web console. It reads only and changes nothing. It needs a connected Phorme account.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Use this when the user asks how one of their lifts is progressing or wants it graphed, for example "how is my bench going" or "chart my squat over six months". It finds the lift in their Phorme log by the words they use and returns one point per session with the best set, estimated max and volume, the change over the period and their best session, and shows a chart card. It reads only and changes nothing. It needs a connected Phorme account. Weights are in pounds. If no lift matched it lists the lifts they have logged.
| Argument | Type | Description |
|---|---|---|
| months | integer | How many months back to look. Defaults to 6. |
| movement* | string | The lift as the user said it, for example "bench", "back squat" or "RDL". |
{
"type": "object",
"required": [
"movement"
],
"properties": {
"months": {
"type": "integer",
"maximum": 24,
"minimum": 1,
"description": "How many months back to look. Defaults to 6."
},
"movement": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "The lift as the user said it, for example \"bench\", \"back squat\" or \"RDL\"."
}
},
"additionalProperties": false
}Use this when a Phorme coach asks for the code or link to share one of their coaching brains, for example "what is my coach code?". Each brain has one code, like K7Q2-XR4D, made the first time it is asked for and kept as the brain changes. Anyone who types it in the Phorme app or opens its link starts with that brain. It needs a connected Phorme account that owns the brain.
| Argument | Type | Description |
|---|---|---|
| brain_id* | string | The brain id from the coach's brains. |
{
"type": "object",
"required": [
"brain_id"
],
"properties": {
"brain_id": {
"type": "string",
"maxLength": 80,
"description": "The brain id from the coach's brains."
}
},
"additionalProperties": false
}Use this when a Phorme coach asks about their own coaching brains: how many members train under each, who went quiet, what they have earned, and whether a note to members can go today. It reads only and changes nothing. It needs a connected Phorme account; an account without a coaching brain gets the address of the coach console.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Use this when an owner wants their share paid to their bank and has not set it up, for example when no bank is set up yet. Confirm with the owner first, and set confirmation to true only after they said yes. It returns a link to Stripe's own form, where the owner gives their bank to Stripe. It is a link only: the bank is never given in the chat, and it takes no payment. It needs a connected Phorme account.
| Argument | Type | Description |
|---|---|---|
| country | string | The two letter country of the bank, for example US. Default US. |
| confirmation* | boolean | Set to true only after the owner said yes to setting up payouts. |
{
"type": "object",
"required": [
"confirmation"
],
"properties": {
"country": {
"type": "string",
"maxLength": 2,
"minLength": 2,
"description": "The two letter country of the bank, for example US. Default US."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to setting up payouts."
}
},
"additionalProperties": false
}Use this when an owner asks what Phorme paid them, or what goes out next, for example "what did Phorme pay my gym?". It returns what the account earned, what was paid out, what is going out, what is owed now, whether a bank is set up, and each recent payout. It reads only and changes nothing. It needs a connected Phorme account.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Use this when the user picked one Phorme program and wants its details. It returns the program, every session of its first week, where to find it in the Phorme app, and a link to a page that describes it. It reads only, shows no prices and starts no purchase.
| Argument | Type | Description |
|---|---|---|
| program_id* | string | The program id returned by search_phorme_programs. |
{
"type": "object",
"required": [
"program_id"
],
"properties": {
"program_id": {
"type": "string",
"maxLength": 160,
"description": "The program id returned by search_phorme_programs."
}
},
"additionalProperties": false
}Use this when the user asks what their Phorme plan has for today or the coming days, for example "what is my workout today". It returns each planned session with its exercises, sets, reps and the loads Phorme set from their own maxes. It reads only and changes nothing, including the plan. It needs a connected Phorme account. Weights are in pounds.
| Argument | Type | Description |
|---|---|---|
| days | integer | How many days ahead, starting today. Defaults to 7. |
{
"type": "object",
"properties": {
"days": {
"type": "integer",
"maximum": 14,
"minimum": 1,
"description": "How many days ahead, starting today. Defaults to 7."
}
},
"additionalProperties": false
}Use this when the user asks about a workout or program already saved to Phorme in this conversation, for example to get its Phorme link again. It returns the title and open link for training owned by the connected Phorme account and changes nothing. It needs the training_id from that save. It cannot list, search, edit or delete training.
| Argument | Type | Description |
|---|---|---|
| training_id* | string | The training_id returned by save_workout_to_phorme or save_program_to_phorme. |
| training_kind* | string | Whether the saved item is a workout or a program. |
{
"type": "object",
"required": [
"training_kind",
"training_id"
],
"properties": {
"training_id": {
"type": "string",
"format": "uuid",
"description": "The training_id returned by save_workout_to_phorme or save_program_to_phorme."
},
"training_kind": {
"enum": [
"workout",
"program"
],
"type": "string",
"description": "Whether the saved item is a workout or a program."
}
},
"additionalProperties": false
}Use this when the user asks about their own training logged in Phorme: what they did last time, how often they trained, their personal records, or a next workout built on their recent sessions. It returns their most recent logged workouts with each exercise's sets, best set, estimated max and volume, how many workouts they logged in the last 7 and 30 days, and their latest records. It reads only and changes nothing. It needs a connected Phorme account. Weights are in pounds.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many recent workouts to return, newest first. Defaults to 10. |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 20,
"minimum": 1,
"description": "How many recent workouts to return, newest first. Defaults to 10."
}
},
"additionalProperties": false
}Use this when an owner asks who wants to book or visit their place, for example "who asked to book this week?". At a place not on the gym plan, class bookings and 1:1 requests are held for 7 days. It returns each one waiting: its hold_id, the place, the class and its local time (or that it is a 1:1 request), the member's first name, their note and best times, when it expires, and whether it can be accepted now. It reads only and changes nothing. It needs a connected Phorme account that owns the place.
| Argument | Type | Description |
|---|---|---|
| place_id | string | Only this place. Leave out for all of the owner's places. |
{
"type": "object",
"properties": {
"place_id": {
"type": "string",
"maxLength": 80,
"description": "Only this place. Leave out for all of the owner's places."
}
},
"additionalProperties": false
}Use this when the user names a race they are training for, for example "IRONMAN 70.3 Barranquilla", "I signed up for the half ironman in Cartagena" or "Chicago Marathon". It finds the race in Phorme's race listings (name, date, city and the race's own page), counts the weeks to race day, and returns the week of Phorme's plan for that kind of race that lines up with race day, with sets, reps, paces, coach notes and a demo link for each exercise. For a triathlon (IRONMAN 70.3, 5150, full) it is swim, bike and run in one plan, with efforts until the athlete's swim and bike tests are in. When the organiser has given them, the race's own logistics come with it (venue, where to pick up the race packet, airport, official hotels from the organiser), with the page and date they were read. It reads only and changes nothing. If the race is not listed it says so; never guess a race date. Do not use it for injury rehab or nutrition.
| Argument | Type | Description |
|---|---|---|
| race* | string | The race as the user named it, for example "IRONMAN 70.3 Barranquilla". |
{
"type": "object",
"required": [
"race"
],
"properties": {
"race": {
"type": "string",
"maxLength": 120,
"minLength": 2,
"description": "The race as the user named it, for example \"IRONMAN 70.3 Barranquilla\"."
}
},
"additionalProperties": false
}Use this when the user wants to turn a multiweek training program from this conversation into trackable Phorme training. It checks every week and workout, matches exercises to the Phorme movement library, and stores a private preview for 24 hours. It does not save training to any account. Do not use it for a single workout, nutrition plans or medical questions.
| Argument | Type | Description |
|---|---|---|
| program* | object | The multiweek program to preview, taken from this conversation. At most 500 workouts in total. |
{
"type": "object",
"required": [
"program"
],
"properties": {
"program": {
"type": "object",
"required": [
"title",
"weeks"
],
"properties": {
"title": {
"type": "string",
"maxLength": 160,
"minLength": 1,
"description": "Program name, for example \"Four week strength base\"."
},
"weeks": {
"type": "array",
"items": {
"type": "object",
"required": [
"week_number",
"workouts"
],
"properties": {
"focus": {
"type": "string",
"maxLength": 300,
"description": "Short focus for the week, for example \"Volume\"."
},
"workouts": {
"type": "array",
"items": {
"type": "object",
"required": [
"day_number",
"exercises"
],
"properties": {
"notes": {
"type": "string",
"maxLength": 2000,
"description": "Short note for the whole workout."
},
"title": {
"type": "string",
"maxLength": 160,
"minLength": 1,
"description": "Workout name, for example \"Lower body strength\"."
},
"exercises": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"sets",
"reps"
],
"properties": {
"load": {
"type": "string",
"maxLength": 80,
"description": "Target load, for example \"80%\", \"135 lb\", \"60 kg\", \"bodyweight\" or \"RPE 8\"."
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Exercise name as written in the conversation, for example \"Back squat\"."
},
"reps": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Reps per set as short text, for example \"8\", \"8-10\", \"AMRAP\" or \"40 sec\"."
},
"rest": {
"type": "string",
"maxLength": 40,
"description": "Rest between sets, for example \"90 sec\" or \"2 min\"."
},
"sets": {
"type": "integer",
"maximum": 20,
"minimum": 1,
"description": "Number of sets."
},
"notes": {
"type": "string",
"maxLength": 500,
"description": "Short coaching note for this exercise."
},
"duration": {
"type": "number",
"maximum": 7200,
"description": "Work time in seconds for a timed exercise.",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "Exercises in the order they are performed. At most 300 sets in total."
},
"day_number": {
"type": "integer",
"maximum": 14,
"minimum": 1,
"description": "Day position within the week, starting at 1. Each day_number appears once in a week."
},
"estimated_duration_minutes": {
"type": "integer",
"maximum": 360,
"minimum": 1,
"description": "Expected length of the workout in minutes."
}
},
"additionalProperties": false
},
"maxItems": 14,
"minItems": 1,
"description": "Workouts in this week."
},
"week_number": {
"type": "integer",
"maximum": 52,
"minimum": 1,
"description": "Week position in the program, starting at 1. Each week_number appears once."
}
},
"additionalProperties": false
},
"maxItems": 52,
"minItems": 1,
"description": "Weeks in order."
},
"difficulty": {
"enum": [
"beginner",
"intermediate",
"advanced"
],
"type": "string",
"description": "Intended training level. Defaults to intermediate."
},
"description": {
"type": "string",
"maxLength": 2000,
"description": "Short summary of the program."
}
},
"description": "The multiweek program to preview, taken from this conversation. At most 500 workouts in total.",
"additionalProperties": false
}
},
"additionalProperties": false
}Use this when the user plays a sport and wants their gym days for a week planned around it, for example two lifting days during basketball season. It picks the closest coach-built Phorme sport program and returns one week of sessions sized to the days the user has, with sets, reps, coach notes and a demo link for each exercise. It reads only and changes nothing in any account. If Phorme has no program for that sport it says so in match_quality and limits. Do not use it for injury rehab, team practice plans for children, or nutrition.
| Argument | Type | Description |
|---|---|---|
| sport* | string | The sport or position, for example "basketball", "volleyball" or "wide receiver". |
| season_phase | string | Where the user is in their season, only if they said. |
| gym_days_per_week* | integer | Gym days the user has this week. Ask when the user did not say. |
{
"type": "object",
"required": [
"sport",
"gym_days_per_week"
],
"properties": {
"sport": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "The sport or position, for example \"basketball\", \"volleyball\" or \"wide receiver\"."
},
"season_phase": {
"enum": [
"off_season",
"pre_season",
"in_season",
"unknown"
],
"type": "string",
"description": "Where the user is in their season, only if they said."
},
"gym_days_per_week": {
"type": "integer",
"maximum": 7,
"minimum": 1,
"description": "Gym days the user has this week. Ask when the user did not say."
}
},
"additionalProperties": false
}Use this when the user wants a single workout they can follow and track in Phorme: one written in this conversation, pasted from notes, or built to fit their time and equipment. It checks the workout, matches each exercise to the Phorme movement library with a demo link, flags anything that needs equipment the user did not list or runs past their time, and stores a private preview for 24 hours. It does not save training to any account. Do not use it for multiweek programs, nutrition plans, or pain and injury questions.
| Argument | Type | Description |
|---|---|---|
| origin | string | Use "sport_week" when the workout is a session returned by preview_sport_week. Otherwise leave out. |
| workout* | object | The workout to preview, taken from this conversation. |
| time_limit_minutes | integer | Minutes the user said they have. Leave out when the user did not say. |
| available_equipment | array | Equipment the user said they have, for example ["dumbbells", "bench"] or ["none"]. Leave out when the user did not say. |
{
"type": "object",
"required": [
"workout"
],
"properties": {
"origin": {
"enum": [
"conversation",
"sport_week"
],
"type": "string",
"description": "Use \"sport_week\" when the workout is a session returned by preview_sport_week. Otherwise leave out."
},
"workout": {
"type": "object",
"required": [
"exercises"
],
"properties": {
"notes": {
"type": "string",
"maxLength": 2000,
"description": "Short note for the whole workout."
},
"title": {
"type": "string",
"maxLength": 160,
"minLength": 1,
"description": "Workout name, for example \"Lower body strength\"."
},
"exercises": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"sets",
"reps"
],
"properties": {
"load": {
"type": "string",
"maxLength": 80,
"description": "Target load, for example \"80%\", \"135 lb\", \"60 kg\", \"bodyweight\" or \"RPE 8\"."
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Exercise name as written in the conversation, for example \"Back squat\"."
},
"reps": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Reps per set as short text, for example \"8\", \"8-10\", \"AMRAP\" or \"40 sec\"."
},
"rest": {
"type": "string",
"maxLength": 40,
"description": "Rest between sets, for example \"90 sec\" or \"2 min\"."
},
"sets": {
"type": "integer",
"maximum": 20,
"minimum": 1,
"description": "Number of sets."
},
"notes": {
"type": "string",
"maxLength": 500,
"description": "Short coaching note for this exercise."
},
"duration": {
"type": "number",
"maximum": 7200,
"description": "Work time in seconds for a timed exercise.",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "Exercises in the order they are performed. At most 300 sets in total."
},
"estimated_duration_minutes": {
"type": "integer",
"maximum": 360,
"minimum": 1,
"description": "Expected length of the workout in minutes."
}
},
"description": "The workout to preview, taken from this conversation.",
"additionalProperties": false
},
"time_limit_minutes": {
"type": "integer",
"maximum": 180,
"minimum": 5,
"description": "Minutes the user said they have. Leave out when the user did not say."
},
"available_equipment": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"maxItems": 20,
"description": "Equipment the user said they have, for example [\"dumbbells\", \"bench\"] or [\"none\"]. Leave out when the user did not say."
}
},
"additionalProperties": false
}Use this when an owner wants the changes to their place's coaching brain to reach members, for example after its voice, look or programs changed. Confirm with the owner first, and set confirmation to true only after they said yes. It runs the same publish checks as the console and publishes the brain when they pass; when one fails it says what is left and members see no change. It needs a connected Phorme account that owns the place.
| Argument | Type | Description |
|---|---|---|
| place_id* | string | The place_id of one of the owner's places, from get_gym_report or create_or_claim_place. |
| confirmation* | boolean | Set to true only after the owner said yes to publishing the coaching brain. |
{
"type": "object",
"required": [
"place_id",
"confirmation"
],
"properties": {
"place_id": {
"type": "string",
"maxLength": 80,
"description": "The place_id of one of the owner's places, from get_gym_report or create_or_claim_place."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to publishing the coaching brain."
}
},
"additionalProperties": false
}Use this when an owner wants their place live on Phorme: its page on phor.me, the app's map and the Phorme connector. Confirm with the owner first, and set confirmation to true only after they said yes. Going live needs an email for booking confirmations and requests: request_email, else the place's own, else the account's. Listing is free; when someone asks to book a place that is not on the gym plan, the ask is held 7 days and the owner is told. It takes no payment and starts no plan. It needs a connected Phorme account that owns the place.
| Argument | Type | Description |
|---|---|---|
| place_id* | string | The place_id of one of the owner's places, from get_gym_report or create_or_claim_place. |
| confirmation* | boolean | Set to true only after the owner said yes to putting this place live. |
| request_email | string | Where booking confirmations and requests are emailed. Never shown in public. |
{
"type": "object",
"required": [
"place_id",
"confirmation"
],
"properties": {
"place_id": {
"type": "string",
"maxLength": 80,
"description": "The place_id of one of the owner's places, from get_gym_report or create_or_claim_place."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to putting this place live."
},
"request_email": {
"type": "string",
"maxLength": 200,
"description": "Where booking confirmations and requests are emailed. Never shown in public."
}
},
"additionalProperties": false
}Use this to show a compact Phorme card for a workout or program that was just previewed or saved. It displays only the title, counts, status and link it is given. It reads and changes nothing in Phorme.
| Argument | Type | Description |
|---|---|---|
| title | string | Training title from the tool result. |
| status | string | "preview" for training not yet saved, "saved" for training saved to Phorme. |
| open_url | string | Link that opens the saved training in Phorme. Not set for previews. |
| training_kind | string | |
| warning_count | integer | |
| exercise_count | integer | |
| estimated_duration_minutes | integer |
{
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 160,
"description": "Training title from the tool result."
},
"status": {
"enum": [
"preview",
"saved"
],
"type": "string",
"description": "\"preview\" for training not yet saved, \"saved\" for training saved to Phorme."
},
"open_url": {
"type": "string",
"maxLength": 300,
"description": "Link that opens the saved training in Phorme. Not set for previews."
},
"training_kind": {
"enum": [
"workout",
"program"
],
"type": "string"
},
"warning_count": {
"type": "integer",
"maximum": 50000,
"minimum": 0
},
"exercise_count": {
"type": "integer",
"maximum": 50000,
"minimum": 0
},
"estimated_duration_minutes": {
"type": "integer",
"maximum": 200000,
"minimum": 0
}
},
"additionalProperties": false
}Use this when a Phorme coach has written a program in this conversation and clearly said to save it to one of their coaching brains. It saves the program as a draft on that brain (session names, exercises, sets and reps); members see nothing until the coach adds the draft in the coach console. It needs a connected Phorme account that owns the brain.
| Argument | Type | Description |
|---|---|---|
| title* | string | |
| weeks | integer | How many weeks the program runs. Defaults to 4. |
| brain_id* | string | The brain id from the coach's brains. |
| sessions* | array | One week of sessions; the app repeats and progresses it. |
| confirmation* | boolean | True only after the coach confirmed this save. |
{
"type": "object",
"required": [
"brain_id",
"title",
"sessions",
"confirmation"
],
"properties": {
"title": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"weeks": {
"type": "integer",
"maximum": 24,
"minimum": 1,
"description": "How many weeks the program runs. Defaults to 4."
},
"brain_id": {
"type": "string",
"maxLength": 80,
"description": "The brain id from the coach's brains."
},
"sessions": {
"type": "array",
"items": {
"type": "object",
"required": [
"title",
"exercises"
],
"properties": {
"title": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"exercises": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"sets"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"reps": {
"type": [
"integer",
"string"
],
"description": "Reps per set, for example 8 or \"8-10\"."
},
"rest": {
"type": "integer",
"maximum": 900,
"minimum": 0,
"description": "Rest in seconds."
},
"sets": {
"type": "integer",
"maximum": 20,
"minimum": 1
},
"seconds": {
"type": "integer",
"maximum": 3600,
"minimum": 1,
"description": "For timed sets instead of reps."
}
},
"additionalProperties": false
},
"maxItems": 30,
"minItems": 1
}
},
"additionalProperties": false
},
"maxItems": 14,
"minItems": 1,
"description": "One week of sessions; the app repeats and progresses it."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "True only after the coach confirmed this save."
}
},
"additionalProperties": false
}Use this when the user has seen a program preview and clearly said to save it. It saves that preview to the connected Phorme account as a private program and returns a link that opens it in Phorme. It needs a connected Phorme account with the training:write permission and a Phorme membership that already includes programs. If the account does not have that membership the tool says so and saves nothing. It never starts a purchase. Retrying with the same idempotency_key does not create a second copy.
| Argument | Type | Description |
|---|---|---|
| preview_id* | string | The preview_id of the preview being saved. |
| confirmation* | boolean | Set to true only after the user clearly confirmed this save in the conversation. |
| idempotency_key* | string | A unique string for this save. Reuse the same value when retrying so no second copy is created. |
{
"type": "object",
"required": [
"preview_id",
"confirmation",
"idempotency_key"
],
"properties": {
"preview_id": {
"type": "string",
"format": "uuid",
"description": "The preview_id of the preview being saved."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the user clearly confirmed this save in the conversation."
},
"idempotency_key": {
"type": "string",
"maxLength": 160,
"minLength": 1,
"description": "A unique string for this save. Reuse the same value when retrying so no second copy is created."
}
},
"additionalProperties": false
}Use this when the user has seen a workout preview and clearly said to save it. It saves that preview to the connected Phorme account as a private workout and returns a link that opens it in Phorme. It needs a connected Phorme account with the training:write permission. Retrying with the same idempotency_key returns the same saved workout and does not create a second copy.
| Argument | Type | Description |
|---|---|---|
| preview_id* | string | The preview_id of the preview being saved. |
| confirmation* | boolean | Set to true only after the user clearly confirmed this save in the conversation. |
| idempotency_key* | string | A unique string for this save. Reuse the same value when retrying so no second copy is created. |
{
"type": "object",
"required": [
"preview_id",
"confirmation",
"idempotency_key"
],
"properties": {
"preview_id": {
"type": "string",
"format": "uuid",
"description": "The preview_id of the preview being saved."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the user clearly confirmed this save in the conversation."
},
"idempotency_key": {
"type": "string",
"maxLength": 160,
"minLength": 1,
"description": "A unique string for this save. Reuse the same value when retrying so no second copy is created."
}
},
"additionalProperties": false
}Use this when the user asks for an existing coach-built training program for their sport or goal, for example a structured volleyball program. It returns up to five matching Phorme programs, each with a sample session from its first week that the user can try now and where to find it in the Phorme app. Every result is a program a member can train in the Phorme app today. It changes nothing, shows no prices and starts no purchase. Results are ordered by fit and never by commission.
| Argument | Type | Description |
|---|---|---|
| goal | string | Training goal, for example "build strength". |
| sport | string | |
| creator | string | Coach or creator name, only if the user named one. |
| equipment | array | Equipment the user has. |
| experience | string | Training level, for example "beginner". |
| schedule_days | integer | Training days per week. |
| duration_weeks | integer |
{
"type": "object",
"properties": {
"goal": {
"type": "string",
"maxLength": 200,
"description": "Training goal, for example \"build strength\"."
},
"sport": {
"type": "string",
"maxLength": 80
},
"creator": {
"type": "string",
"maxLength": 120,
"description": "Coach or creator name, only if the user named one."
},
"equipment": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60
},
"maxItems": 20,
"description": "Equipment the user has."
},
"experience": {
"type": "string",
"maxLength": 40,
"description": "Training level, for example \"beginner\"."
},
"schedule_days": {
"type": "integer",
"maximum": 7,
"minimum": 1,
"description": "Training days per week."
},
"duration_weeks": {
"type": "integer",
"maximum": 52,
"minimum": 1
}
},
"additionalProperties": false
}Use this when a Phorme coach has written a short note to everyone training under one of their published coaching brains and clearly said to send it. It sends the coach's words as they are, as a notification and in each member's coach history: up to 400 characters, no links, one note per brain per day. It needs a connected Phorme account with an active coach plan that owns the brain.
| Argument | Type | Description |
|---|---|---|
| text* | string | The coach's own words, exactly as they approved them. |
| brain_id* | string | |
| confirmation* | boolean | True only after the coach confirmed this exact note. |
{
"type": "object",
"required": [
"brain_id",
"text",
"confirmation"
],
"properties": {
"text": {
"type": "string",
"maxLength": 400,
"minLength": 1,
"description": "The coach's own words, exactly as they approved them."
},
"brain_id": {
"type": "string",
"maxLength": 80
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "True only after the coach confirmed this exact note."
}
},
"additionalProperties": false
}Use this when an owner wants booking and ask notices for a place sent somewhere else, for example "text my bookings to my phone". send_to is an email, or a phone that gets them as texts; one at a time, as in the console. An empty send_to sends them to the account's own phone or email. Read it back to the owner first, and set confirmation to true only after they said yes. The phone is never shown on the place's page. It needs a connected Phorme account that owns the place.
| Argument | Type | Description |
|---|---|---|
| send_to* | string | An email, or a phone with its country code for texts, for example +15125550100. "" for the account's own. |
| place_id* | string | The place_id of one of the owner's places, from get_gym_report or create_or_claim_place. |
| confirmation* | boolean | Set to true only after the owner said yes to where booking notices go. |
{
"type": "object",
"required": [
"place_id",
"send_to",
"confirmation"
],
"properties": {
"send_to": {
"type": "string",
"maxLength": 200,
"description": "An email, or a phone with its country code for texts, for example +15125550100. \"\" for the account's own."
},
"place_id": {
"type": "string",
"maxLength": 80,
"description": "The place_id of one of the owner's places, from get_gym_report or create_or_claim_place."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to where booking notices go."
}
},
"additionalProperties": false
}Use this when an owner wants to see, add, change or cancel a class at their place. action list reads the schedule and changes nothing. For add, edit and cancel, read the class, day and time back to the owner first, and set confirmation to true only after they said yes. A class people booked keeps its time, length and price; a class members paid for cannot be cancelled here. Members pay for a paid class on Phorme's own payment page; this tool takes no payment. It needs a connected Phorme account that owns the place.
| Argument | Type | Description |
|---|---|---|
| line | string | One line on the class. |
| title | string | The class name, for example "Barbell basics". |
| action* | string | |
| minutes | integer | |
| capacity | integer | How many people it takes. |
| class_id | string | For edit and cancel: the class_id from action list. |
| place_id* | string | The place_id of one of the owner's places, from get_gym_report or create_or_claim_place. |
| price_usd |
Use this when an owner on the gym plan wants to pay for their members' Phorme membership at one place, so members train free, or wants to stop. Confirm with the owner first, and set confirmation to true only after they said yes. It turns the switch on or off and can lower the cap of members covered (up to 50). Members join from the app and the place approves them. A place not on the gym plan cannot turn it on; the result then gives plan_url, the plan on phor.me. It takes no payment here. It needs a connected Phorme account that owns the place.
| Argument | Type | Description |
|---|---|---|
| on* | boolean | true to cover members, false to stop. |
| cap | integer | Most members covered at this place. Default 50. |
| place_id* | string | The place_id of one of the owner's places, from get_gym_report or create_or_claim_place. |
| confirmation* | boolean | Set to true only after the owner said yes to this change to member cover. |
{
"type": "object",
"required": [
"place_id",
"on",
"confirmation"
],
"properties": {
"on": {
"type": "boolean",
"description": "true to cover members, false to stop."
},
"cap": {
"type": "integer",
"maximum": 50,
"minimum": 0,
"description": "Most members covered at this place. Default 50."
},
"place_id": {
"type": "string",
"maxLength": 80,
"description": "The place_id of one of the owner's places, from get_gym_report or create_or_claim_place."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to this change to member cover."
}
},
"additionalProperties": false
}Use this when a Phorme coach describes how they coach and wants their coaching brain to follow it, for example "every session starts with mobility, main lifts stay in 3 to 6 reps, never two hard days in a row". Sent with the coach's words, it reads them into the brain's rules and saves nothing: it returns the rules, one plain line per rule, and what no rule covers yet. Sent with those rules and confirmation, it saves them, and Phorme checks the brain on sample members and says whether every plan still works. Members train by the saved rules from their next session. It needs a connected Phorme account that owns the brain; set confirmation to true only after the coach said yes to the rules as read back.
| Argument | Type | Description |
|---|---|---|
| text | string | How the coach coaches, in their own words from this conversation. Never invented. Sent to read a draft. |
| rules | object | The rules a draft returned, unchanged or as the coach corrected them: method, voice, banned_phrases and share. Sent to save. |
| brain_id* | string | The brain id from the coach's brains. |
| confirmation | boolean | True only after the coach confirmed these rules. Needed to save. |
{
"type": "object",
"required": [
"brain_id"
],
"properties": {
"text": {
"type": "string",
"maxLength": 4000,
"minLength": 10,
"description": "How the coach coaches, in their own words from this conversation. Never invented. Sent to read a draft."
},
"rules": {
"type": "object",
"description": "The rules a draft returned, unchanged or as the coach corrected them: method, voice, banned_phrases and share. Sent to save."
},
"brain_id": {
"type": "string",
"maxLength": 80,
"description": "The brain id from the coach's brains."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "True only after the coach confirmed these rules. Needed to save."
}
},
"additionalProperties": false
}Use this when an owner who signed in by phone wants notices about their gym plan sent to an email. Read the email back to the owner first, and set confirmation to true only after they said yes. An empty email clears it, and notices go to the account's own email or phone. It is never shown to members. It needs a connected Phorme account.
| Argument | Type | Description |
|---|---|---|
| email* | string | The owner's email, or "" to clear it. |
| confirmation* | boolean | Set to true only after the owner said yes to this email. |
{
"type": "object",
"required": [
"email",
"confirmation"
],
"properties": {
"email": {
"type": "string",
"maxLength": 200,
"description": "The owner's email, or \"\" to clear it."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to this email."
}
},
"additionalProperties": false
}Use this when an owner wants a coaching brain for their place, so members train with the gym's own coach in the Phorme app. Confirm with the owner first, and set confirmation to true only after they said yes. In one step it makes a brain from the place's name, line and classes, gives it a starting program from the Phorme library, publishes it and puts the place's members under it, the same as the console's one-click start. The owner can change it in the builder after. Free on the free listing too. It needs a connected Phorme account that owns the place.
| Argument | Type | Description |
|---|---|---|
| place_id* | string | The place_id of one of the owner's places, from get_gym_report or create_or_claim_place. |
| confirmation* | boolean | Set to true only after the owner said yes to starting a coaching brain for this place. |
| days_per_week | integer | Training days a week the starting program is built for. Default 3. |
{
"type": "object",
"required": [
"place_id",
"confirmation"
],
"properties": {
"place_id": {
"type": "string",
"maxLength": 80,
"description": "The place_id of one of the owner's places, from get_gym_report or create_or_claim_place."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to starting a coaching brain for this place."
},
"days_per_week": {
"type": "integer",
"maximum": 7,
"minimum": 1,
"description": "Training days a week the starting program is built for. Default 3."
}
},
"additionalProperties": false
}Use this when a coach or trainer wants to turn their own method into a Phorme coaching brain and has none yet, or asks for a new one. It creates a draft brain with the name they chose and their method in their own words; members see nothing until the coach publishes it in the coach console. A first program can then be saved to it as a draft. It needs a connected Phorme account; signing in with a phone number creates one.
| Argument | Type | Description |
|---|---|---|
| name* | string | The brain's name, as the coach chose it, for example "Hayes Strength". |
| method | string | How the coach trains people, in their own words from this conversation. Never invented. |
| tagline | string | One line on who it is for, in the coach's words. |
| confirmation* | boolean | True only after the coach confirmed the name and method. |
{
"type": "object",
"required": [
"name",
"confirmation"
],
"properties": {
"name": {
"type": "string",
"maxLength": 40,
"minLength": 2,
"description": "The brain's name, as the coach chose it, for example \"Hayes Strength\"."
},
"method": {
"type": "string",
"maxLength": 4000,
"description": "How the coach trains people, in their own words from this conversation. Never invented."
},
"tagline": {
"type": "string",
"maxLength": 80,
"description": "One line on who it is for, in the coach's words."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "True only after the coach confirmed the name and method."
}
},
"additionalProperties": false
}Use this when an owner wants their place off Phorme for now. Confirm with the owner first, and set confirmation to true only after they said yes. Its page, the app's map and the Phorme connector stop listing it; its details and classes are kept, so it can be put live again. It needs a connected Phorme account that owns the place.
| Argument | Type | Description |
|---|---|---|
| place_id* | string | The place_id of one of the owner's places, from get_gym_report or create_or_claim_place. |
| confirmation* | boolean | Set to true only after the owner said yes to taking this place down. |
{
"type": "object",
"required": [
"place_id",
"confirmation"
],
"properties": {
"place_id": {
"type": "string",
"maxLength": 80,
"description": "The place_id of one of the owner's places, from get_gym_report or create_or_claim_place."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to taking this place down."
}
},
"additionalProperties": false
}Use this when an owner wants to change how their place's coaching brain sounds or looks: its name, its one line, its voice (how the coach talks to members), its method, its colour or its cover photo. Read the change back to the owner first, and set confirmation to true only after they said yes. Only the things given change; an empty value clears one. It saves to the brain; members get it once the brain is published again. The place needs a coaching brain first. It needs a connected Phorme account that owns the place.
| Argument | Type | Description |
|---|---|---|
| name | string | The coach's name members see. |
| color | string | The brand colour, as #rrggbb. |
| voice | string | How the coach talks to members, in the owner's words. |
| method | string | How the gym trains: the principles the coach plans by. |
| tagline | string | One line under the name. |
| place_id* | string | The place_id of one of the owner's places, from get_gym_report or create_or_claim_place. |
| confirmation* | boolean | Set to true only after the owner said yes to these changes to the coaching brain. |
| cover_image_url |
Use this when an owner wants to change what their place's page says: name, address, hours, booking link, what kind of place it is, the line about it, its time zone, its phone, its price list or the email for requests. Read the change back to the owner first, and set confirmation to true only after they said yes. Only the things given change; an empty value clears one. A new address moves the map pin. A live page shows the change at once. The price list only shows what the place charges; nothing is sold here. It needs a connected Phorme account that owns the place.
| Argument | Type | Description |
|---|---|---|
| lat | number | Latitude of the map pin, only to set it by hand. |
| lon | number | Longitude of the map pin, only to set it by hand. |
| city | string | |
| kind | string | What the place is: gym (also studios and boxes) or a kind of care. |
| line | string | One line on what the place is, in the owner's words. |
| name | string | |
| about | string | One or two plain sentences about the place, in the owner's words. |
| hours | array | Opening hours, one line each, for example ["Mon to Fri, 6 am to 9 pm", "Sat, 8 am to noon"]. |
Use this when an owner has the six digit code Phorme sent to their place's own email or phone after they claimed it. Read the code back to the owner first, and set confirmation to true only after they said yes. A right code makes the connected account the place's owner; a wrong one changes nothing, and after five wrong tries or 24 hours the place must be claimed again. It takes no payment. It needs a connected Phorme account.
| Argument | Type | Description |
|---|---|---|
| code* | string | The six digit code, as the owner gave it. |
| claim_id* | string | The claim_id from claim_place. |
| confirmation* | boolean | Set to true only after the owner said yes to entering this code. |
{
"type": "object",
"required": [
"claim_id",
"code",
"confirmation"
],
"properties": {
"code": {
"type": "string",
"maxLength": 12,
"minLength": 6,
"description": "The six digit code, as the owner gave it."
},
"claim_id": {
"type": "string",
"format": "uuid",
"description": "The claim_id from claim_place."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to entering this code."
}
},
"additionalProperties": false
}| Opening hours, one line each, for example ["Mon to Fri, 6 am to 9 pm", "Sat, 8 am to noon"]. |
| phone | string | The place's public phone number, as the owner gave it. |
| prices | string | array | What training at the place costs, shown on its page, in the owner's own words: one line each, for example "Drop-in 25 dollars", or { label, amount (in dollars) or amount_cents, period, note }. At most 12; an empty list clears them. Repeat them only to the owner. |
| address | string | The street address. The map pin is found from it. |
| country* | string | For example "United States". |
| website | string | The place's own website, starting with https://. |
| book_url | string | The place's own booking page, starting with https://. |
| timezone | string | The place's IANA time zone, for example "America/Chicago". |
| book_label | string | The words on its booking button, for example "Book a class". |
| confirmation* | boolean | Set to true only after the owner said yes to listing this place. |
| request_email | string | Where booking confirmations and requests are emailed. Never shown in public. |
{
"type": "object",
"required": [
"name",
"city",
"country",
"confirmation"
],
"properties": {
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "Latitude of the map pin, only to set it by hand."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "Longitude of the map pin, only to set it by hand."
},
"city": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"kind": {
"enum": [
"gym",
"physio",
"sports_medicine",
"chiropractic",
"massage",
"recovery"
],
"type": "string",
"description": "What the place is: gym (also studios and boxes) or a kind of care."
},
"line": {
"type": "string",
"maxLength": 140,
"description": "One line on what the place is, in the owner's words."
},
"name": {
"type": "string",
"maxLength": 60,
"minLength": 2,
"description": "The place's name, as the owner wrote it."
},
"about": {
"type": "string",
"maxLength": 600,
"description": "One or two plain sentences about the place, in the owner's words."
},
"hours": {
"type": "array",
"items": {
"type": "string",
"maxLength": 80
},
"maxItems": 8,
"description": "Opening hours, one line each, for example [\"Mon to Fri, 6 am to 9 pm\", \"Sat, 8 am to noon\"]."
},
"phone": {
"type": "string",
"maxLength": 30,
"description": "The place's public phone number, as the owner gave it."
},
"prices": {
"type": [
"string",
"array"
],
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "object",
"required": [
"label"
],
"properties": {
"note": {
"type": "string",
"maxLength": 120
},
"label": {
"type": "string",
"maxLength": 60,
"description": "For example \"Drop-in\" or \"Ten class pack\"."
},
"amount": {
"type": "number",
"maximum": 100000,
"minimum": 0,
"description": "In dollars."
},
"period": {
"enum": [
"drop_in",
"day",
"week",
"month",
"year",
"class_pack",
"other"
],
"type": "string"
},
"amount_cents": {
"type": "integer",
"maximum": 10000000,
"minimum": 0
}
},
"additionalProperties": false
}
]
},
"maxItems": 12,
"description": "What training at the place costs, shown on its page, in the owner's own words: one line each, for example \"Drop-in 25 dollars\", or { label, amount (in dollars) or amount_cents, period, note }. At most 12; an empty list clears them. Repeat them only to the owner."
},
"address": {
"type": "string",
"maxLength": 200,
"description": "The street address. The map pin is found from it."
},
"country": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "For example \"United States\"."
},
"website": {
"type": "string",
"maxLength": 300,
"description": "The place's own website, starting with https://."
},
"book_url": {
"type": "string",
"maxLength": 300,
"description": "The place's own booking page, starting with https://."
},
"timezone": {
"type": "string",
"maxLength": 60,
"description": "The place's IANA time zone, for example \"America/Chicago\"."
},
"book_label": {
"type": "string",
"maxLength": 40,
"description": "The words on its booking button, for example \"Book a class\"."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to listing this place."
},
"request_email": {
"type": "string",
"maxLength": 200,
"description": "Where booking confirmations and requests are emailed. Never shown in public."
}
},
"additionalProperties": false
}{
"type": "object",
"properties": {
"code": {
"type": "string",
"maxLength": 80,
"description": "A Phorme coach code exactly as the user gave it, for example \"K7Q2-XR4D\", or a phor.me/c/ link. Only when they gave one."
},
"goal": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "What the user wants from training, in their words, for example \"jump higher\" or \"first HYROX race\". Needed unless a code is given."
},
"coach": {
"type": "string",
"maxLength": 80,
"description": "A coach the user named, for example \"Cameron Goodson\". Only that coach's brains are returned."
},
"sport": {
"type": "string",
"maxLength": 80,
"description": "The sport or position, only if the user named one."
},
"days_per_week": {
"type": "integer",
"maximum": 7,
"minimum": 1,
"description": "Training days a week, only if the user said."
}
},
"additionalProperties": false
}{
"type": "object",
"properties": {
"city": {
"type": "string",
"maxLength": 80,
"description": "The city the user named, for example \"Austin\"."
},
"days": {
"type": "integer",
"maximum": 14,
"minimum": 1,
"description": "How many days ahead to look. Default 7."
},
"near_lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "Latitude, only if the user shared their position."
},
"near_lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "Longitude, only if the user shared their position."
},
"radius_km": {
"type": "integer",
"maximum": 300,
"minimum": 1,
"description": "How far from the shared position to look, in km. Default 60. Use a larger one only when the user said they would travel."
},
"class_type": {
"type": "string",
"maxLength": 60,
"description": "The kind of class, only if the user said, for example \"barbell\" or \"yoga\"."
}
},
"additionalProperties": false
}| number |
| What one place in the class costs, as the owner set it. 0 or left out for free. Never repeat it to anyone but the owner. |
| starts_at | string | When it starts: "YYYY-MM-DDTHH:MM" in the place's own time, or an ISO time with its offset. |
| confirmation | boolean | Set to true only after the owner said yes to this class change. |
{
"type": "object",
"required": [
"place_id",
"action"
],
"properties": {
"line": {
"type": "string",
"maxLength": 140,
"description": "One line on the class."
},
"title": {
"type": "string",
"maxLength": 60,
"minLength": 2,
"description": "The class name, for example \"Barbell basics\"."
},
"action": {
"enum": [
"list",
"add",
"edit",
"cancel"
],
"type": "string"
},
"minutes": {
"type": "integer",
"maximum": 480,
"minimum": 5
},
"capacity": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "How many people it takes."
},
"class_id": {
"type": "string",
"format": "uuid",
"description": "For edit and cancel: the class_id from action list."
},
"place_id": {
"type": "string",
"maxLength": 80,
"description": "The place_id of one of the owner's places, from get_gym_report or create_or_claim_place."
},
"price_usd": {
"type": "number",
"maximum": 1000,
"minimum": 0,
"description": "What one place in the class costs, as the owner set it. 0 or left out for free. Never repeat it to anyone but the owner."
},
"starts_at": {
"type": "string",
"maxLength": 40,
"description": "When it starts: \"YYYY-MM-DDTHH:MM\" in the place's own time, or an ISO time with its offset."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to this class change."
}
},
"additionalProperties": false
}| string |
| An https link to the cover photo. |
{
"type": "object",
"required": [
"place_id",
"confirmation"
],
"properties": {
"name": {
"type": "string",
"maxLength": 40,
"minLength": 2,
"description": "The coach's name members see."
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"description": "The brand colour, as #rrggbb."
},
"voice": {
"type": "string",
"maxLength": 4000,
"description": "How the coach talks to members, in the owner's words."
},
"method": {
"type": "string",
"maxLength": 4000,
"description": "How the gym trains: the principles the coach plans by."
},
"tagline": {
"type": "string",
"maxLength": 80,
"description": "One line under the name."
},
"place_id": {
"type": "string",
"maxLength": 80,
"description": "The place_id of one of the owner's places, from get_gym_report or create_or_claim_place."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to these changes to the coaching brain."
},
"cover_image_url": {
"type": "string",
"maxLength": 500,
"description": "An https link to the cover photo."
}
},
"additionalProperties": false
}| phone |
| string |
| The place's public phone number, as the owner gave it. |
| prices | string | array | What training at the place costs, shown on its page, in the owner's own words: one line each, for example "Drop-in 25 dollars", or { label, amount (in dollars) or amount_cents, period, note }. At most 12; an empty list clears them. Repeat them only to the owner. |
| address | string | The street address. The map pin is found from it. |
| country | string |
| website | string | The place's own website, starting with https://. |
| book_url | string | The place's own booking page, starting with https://. |
| place_id* | string | The place_id of one of the owner's places, from get_gym_report or create_or_claim_place. |
| timezone | string | The place's IANA time zone, for example "America/Chicago". |
| book_label | string | The words on its booking button, for example "Book a class". |
| confirmation* | boolean | Set to true only after the owner said yes to these changes. |
| request_email | string | Where booking confirmations and requests are emailed. Never shown in public. |
{
"type": "object",
"required": [
"place_id",
"confirmation"
],
"properties": {
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "Latitude of the map pin, only to set it by hand."
},
"lon": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "Longitude of the map pin, only to set it by hand."
},
"city": {
"type": "string",
"maxLength": 60
},
"kind": {
"enum": [
"gym",
"physio",
"sports_medicine",
"chiropractic",
"massage",
"recovery"
],
"type": "string",
"description": "What the place is: gym (also studios and boxes) or a kind of care."
},
"line": {
"type": "string",
"maxLength": 140,
"description": "One line on what the place is, in the owner's words."
},
"name": {
"type": "string",
"maxLength": 60,
"minLength": 2
},
"about": {
"type": "string",
"maxLength": 600,
"description": "One or two plain sentences about the place, in the owner's words."
},
"hours": {
"type": "array",
"items": {
"type": "string",
"maxLength": 80
},
"maxItems": 8,
"description": "Opening hours, one line each, for example [\"Mon to Fri, 6 am to 9 pm\", \"Sat, 8 am to noon\"]."
},
"phone": {
"type": "string",
"maxLength": 30,
"description": "The place's public phone number, as the owner gave it."
},
"prices": {
"type": [
"string",
"array"
],
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "object",
"required": [
"label"
],
"properties": {
"note": {
"type": "string",
"maxLength": 120
},
"label": {
"type": "string",
"maxLength": 60,
"description": "For example \"Drop-in\" or \"Ten class pack\"."
},
"amount": {
"type": "number",
"maximum": 100000,
"minimum": 0,
"description": "In dollars."
},
"period": {
"enum": [
"drop_in",
"day",
"week",
"month",
"year",
"class_pack",
"other"
],
"type": "string"
},
"amount_cents": {
"type": "integer",
"maximum": 10000000,
"minimum": 0
}
},
"additionalProperties": false
}
]
},
"maxItems": 12,
"description": "What training at the place costs, shown on its page, in the owner's own words: one line each, for example \"Drop-in 25 dollars\", or { label, amount (in dollars) or amount_cents, period, note }. At most 12; an empty list clears them. Repeat them only to the owner."
},
"address": {
"type": "string",
"maxLength": 200,
"description": "The street address. The map pin is found from it."
},
"country": {
"type": "string",
"maxLength": 60
},
"website": {
"type": "string",
"maxLength": 300,
"description": "The place's own website, starting with https://."
},
"book_url": {
"type": "string",
"maxLength": 300,
"description": "The place's own booking page, starting with https://."
},
"place_id": {
"type": "string",
"maxLength": 80,
"description": "The place_id of one of the owner's places, from get_gym_report or create_or_claim_place."
},
"timezone": {
"type": "string",
"maxLength": 60,
"description": "The place's IANA time zone, for example \"America/Chicago\"."
},
"book_label": {
"type": "string",
"maxLength": 40,
"description": "The words on its booking button, for example \"Book a class\"."
},
"confirmation": {
"type": "boolean",
"const": true,
"description": "Set to true only after the owner said yes to these changes."
},
"request_email": {
"type": "string",
"maxLength": 200,
"description": "Where booking confirmations and requests are emailed. Never shown in public."
}
},
"additionalProperties": false
}