create_space

Creates a space for one capture. An account that does not pay for hosting yet gets its first space as a free private preview: upload and process it with no payment. After that, it returns a Stripe Checkout link for the plan the person chose (pay as you go when none is given) for them to pay; then call wait_for_payment. Never ask for card details.

Argument	Type	Description
plan	string	Optional plan name or ID from list_plans.
title*	string	Title of the space, 1 to 200 characters.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "title"
  ],
  "properties": {
    "plan": {
      "type": "string",
      "description": "Optional plan name or ID from list_plans."
    },
    "title": {
      "type": "string",
      "description": "Title of the space, 1 to 200 characters."
    }
  }
}

create_tour

Starts a private guided tour or scavenger hunt on a space from find_tour_spaces; fill it with draft_tour or save_tour.

Argument	Type	Description
kind	string
title	string
scene_id*	string	The sceneId from find_tour_spaces.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "scene_id"
  ],
  "properties": {
    "kind": {
      "enum": [
        "tour",
        "hunt"
      ],
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "scene_id": {
      "type": "string",
      "description": "The sceneId from find_tour_spaces."
    }
  }
}

draft_tour

Asks the site's tour agent, which sees the space's photographs, to write or rework the tour from a plain request: stops and text, hidden objects and clues, library models, effects, sound, music, looks with transitions and skies (day, sunset, storm, night, stars). It places everything and saves. Returns at once; then call wait_for_tour.

destructive

Argument	Type	Description
request*	string
tour_id*	string	The tour ID (12 hexadecimal characters) from create_tour or list_tours.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "tour_id",
    "request"
  ],
  "properties": {
    "request": {
      "type": "string"
    },
    "tour_id": {
      "type": "string",
      "description": "The tour ID (12 hexadecimal characters) from create_tour or list_tours."
    }
  }
}

find_tour_spaces

Spaces a guided tour or scavenger hunt can be built on: the person's own finished spaces and the site's public spaces (museums, temples, tombs, gardens). Search by words in the title.

read-only

Argument	Type	Description
query	string

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string"
    }
  }
}

finish_upload

Checks that every uploaded file is complete and submits the space for processing. The account is emailed when the space is ready.

Argument	Type	Description
notes	string	Optional notes for processing, such as what the capture is or how the tour should go.
output	string	What to build: "splat", a 3DGS (3D Gaussian splat) visitors move through freely (the default for photos, video and 360 captures); "tour", a guided tour of 360 panoramas (the default for E57 scans); or "auto" to use those defaults. Set it only when the person asks for one.
submit	boolean	Defaults to true.
space_id*	string	The space ID (12 hexadecimal characters) from create_space or space_status.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "space_id"
  ],
  "properties": {
    "notes": {
      "type": "string",
      "description": "Optional notes for processing, such as what the capture is or how the tour should go."
    },
    "output": {
      "enum": [
        "splat",
        "tour",
        "auto"
      ],
      "type": "string",
      "description": "What to build: \"splat\", a 3DGS (3D Gaussian splat) visitors move through freely (the default for photos, video and 360 captures); \"tour\", a guided tour of 360 panoramas (the default for E57 scans); or \"auto\" to use those defaults. Set it only when the person asks for one."
    },
    "submit": {
      "type": "boolean",
      "description": "Defaults to true."
    },
    "space_id": {
      "type": "string",
      "description": "The space ID (12 hexadecimal characters) from create_space or space_status."
    }
  }
}

get_tour

The tour as JSON (stops, objects, effects, looks, skies) with its revision, for editing with save_tour.

read-only

Argument	Type	Description
tour_id*	string	The tour ID (12 hexadecimal characters) from create_tour or list_tours.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "tour_id"
  ],
  "properties": {
    "tour_id": {
      "type": "string",
      "description": "The tour ID (12 hexadecimal characters) from create_tour or list_tours."
    }
  }
}

link_account

Links this agent to the person's account. Returns a link where the person signs in and approves a short code; call again once they have. Never ask for a password.

Argument	Type	Description
link_code	string	Only for connections without a session, the link_code from the previous call.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "link_code": {
      "type": "string",
      "description": "Only for connections without a session, the link_code from the previous call."
    }
  }
}

list_plans

The ways to pay for hosting, with prices, and the account's current plan. The first space is a free private preview, so show them when the person wants to publish it or keep it.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {}
}

list_tours

The tours and scavenger hunts on the account, with their links.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {}
}

save_tour

Saves a tour edited by hand: the experience JSON from get_tour with changes. Models use a url from search_models, or any https address of a .glb.

destructive

Argument	Type	Description
title	string
tour_id*	string	The tour ID (12 hexadecimal characters) from create_tour or list_tours.
experience*	object

Input schema (JSON)

{
  "type": "object",
  "required": [
    "tour_id",
    "experience"
  ],
  "properties": {
    "title": {
      "type": "string"
    },
    "tour_id": {
      "type": "string",
      "description": "The tour ID (12 hexadecimal characters) from create_tour or list_tours."
    },
    "experience": {
      "type": "object"
    }
  }
}

search_models

Searches the library of ready-made 3D models (statues, amphorae, temples, furniture, animals, props from many periods). Returns each model's size and url.

read-only

Argument	Type	Description
limit	number
query*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "limit": {
      "type": "number"
    },
    "query": {
      "type": "string"
    }
  }
}

set_visibility

Makes a ready space public (anyone with the link) or private (only the owner). Ask the person first. A free preview cannot be public until hosting starts, so it returns a Stripe Checkout link for the person to pay.

Argument	Type	Description
public*	boolean
space_id*	string	The space ID (12 hexadecimal characters) from create_space or space_status.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "space_id",
    "public"
  ],
  "properties": {
    "public": {
      "type": "boolean"
    },
    "space_id": {
      "type": "string",
      "description": "The space ID (12 hexadecimal characters) from create_space or space_status."
    }
  }
}

share_tour

Makes a tour public (anyone with its link, never listed) or private, and optionally renames it. Ask the person first.

Argument	Type	Description
title	string
public	boolean
tour_id*	string	The tour ID (12 hexadecimal characters) from create_tour or list_tours.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "tour_id"
  ],
  "properties": {
    "title": {
      "type": "string"
    },
    "public": {
      "type": "boolean"
    },
    "tour_id": {
      "type": "string",
      "description": "The tour ID (12 hexadecimal characters) from create_tour or list_tours."
    }
  }
}

space_status

Status of one space, or every space on the account with its link when ready.

read-only

Argument	Type	Description
space_id	string	The space ID (12 hexadecimal characters) from create_space or space_status.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "space_id": {
      "type": "string",
      "description": "The space ID (12 hexadecimal characters) from create_space or space_status."
    }
  }
}

unlink_account

Unlinks this agent from the account.

destructive

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {}
}

upload_files

Starts resumable uploads for capture files you hold (for example photos or video the person shared with you) and returns where to PUT each file's bytes. For files on the person's own device, give them the space's page to drop the files instead.

Argument	Type	Description
files*	array
space_id*	string	The space ID (12 hexadecimal characters) from create_space or space_status.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "space_id",
    "files"
  ],
  "properties": {
    "files": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name",
          "size"
        ],
        "properties": {
          "name": {
            "type": "string"
          },
          "size": {
            "type": "integer",
            "description": "Size in bytes."
          },
          "type": {
            "type": "string",
            "description": "Optional MIME type."
          }
        }
      }
    },
    "space_id": {
      "type": "string",
      "description": "The space ID (12 hexadecimal characters) from create_space or space_status."
    }
  }
}

wait_for_payment

Waits up to 25 seconds for the person to finish paying in Stripe Checkout, whether for a space's first payment or to publish a free preview. Call it again to keep waiting.

read-only

Argument	Type	Description
space_id*	string	The space ID (12 hexadecimal characters) from create_space or space_status.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "space_id"
  ],
  "properties": {
    "space_id": {
      "type": "string",
      "description": "The space ID (12 hexadecimal characters) from create_space or space_status."
    }
  }
}

wait_for_tour

Waits up to 25 seconds for a draft to finish, then summarizes the tour. Call it again to keep waiting.

read-only

Argument	Type	Description
tour_id*	string	The tour ID (12 hexadecimal characters) from create_tour or list_tours.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "tour_id"
  ],
  "properties": {
    "tour_id": {
      "type": "string",
      "description": "The tour ID (12 hexadecimal characters) from create_tour or list_tours."
    }
  }
}

Spacery

Try it

create_space

Spacery

Try it

create_space

Tools (18)