Skip to main content

Interactive Notebook

A self-contained Jupyter notebook that walks through the full Agent API lifecycle — no local setup beyond an API key.

Open it in Google Colab (File → Upload notebook) or run locally with pip install -r requirements.txt && jupyter lab agents_api_demo.ipynb.

What the notebook covers

  1. List workflows — discover the workflows available on your instance
  2. Search for files — find files by name and get their IDs
  3. Launch an agent — start a workflow agent with file inputs
  4. Poll for completion — wait for the agent to finish processing
  5. Get conversation — retrieve the agent's reasoning and responses
  6. Get artifacts — download structured outputs (documents, tables)
  7. Follow-up — continue the conversation with a new prompt

Each step makes a single API call and shows you the request and response, so you can see exactly what's happening over the wire.

Prerequisites

  • Your Drive instance name (the subdomain from your Drive URL)
  • An API key with the developer scope — create one in Developer > API Keys
  • At least one file uploaded to your instance

Requirements

The notebook installs its own dependencies (requests, pygments) on first run. For local use with JupyterLab, install the full set first:

pip install requests pygments ipywidgets jupyterlab

Note: The notebook uses interactive widgets (dropdowns, text fields). Run it in Google Colab or JupyterLab for best results — VS Code's notebook renderer has limited widget support.