Spacery

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.

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

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.

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

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.

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

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.

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

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.

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

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

{
  "type": "object",
  "properties": {
    "space_id": {
      "type": "string",
      "description": "The space ID (12 hexadecimal characters) from create_space or space_status."
    },
    "notes": {
      "type": "string",
      "description": "Optional notes for processing, such as what the capture is or how the tour should go."
    },
    "output": {
      "type": "string",
      "enum": [
        "splat",
        "tour",
        "auto"
      ],
      "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."
    }
  },
  "required": [
    "space_id"
  ]
}

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

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

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.

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

Unlinks this agent from the account.

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

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.

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

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

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

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

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

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.

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

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

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

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

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

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.

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

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

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

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

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