get_field()

Python
TypeScript

After the checklist completes and agent.on_task_complete fires, use call.get_field() to retrieve collected values by their key. This is where you write results to your CRM, database, or EHR.

signature

def get_field(field_key: str) -> str | int | dict | None

example.py

@agent.on_task_complete("schedule_appointment")
def on_appointment_scheduled(call: guava.Call):
    appointment_time = call.get_field("appointment_time")
    patient_name = call.get_field("patient_name")
    # Write to your CRM / EHR
    save_appointment(patient_name, appointment_time)
    call.hangup()

After the checklist completes and agent.onTaskComplete fires, use call.getField() to retrieve collected values by their key. This is where you write results to your CRM, database, or EHR.

signature

getField(key: string): Promise<any | null>

example.ts

agent.onTaskComplete("schedule_appointment", async (call: guava.Call) => {
  const appointmentTime = await call.getField("appointment_time");
  const patientName = await call.getField("patient_name");
  // Write to your CRM / EHR
  saveAppointment(patientName, appointmentTime);
  await call.hangup();
})

Return types by field type

Python
TypeScript

The type of the value returned by get_field() depends on the field’s field_type:

`field_type`	Returned value
`text`	`str`
`date`	`dict` with keys `year`, `month`, `day` (all `int`)
`integer`	`int`
`multiple_choice`	`str` (guaranteed to be one of the values in `choices` or a search result)
`calendar_slot`	ISO-8601 datetime string (e.g. `"2022-12-25T16:30"`)

You can call get_field() at any point after the field has been collected — not just in on_task_complete. Use it in mid-call callbacks to personalize subsequent steps.

The type of the value returned by getField() depends on the field’s fieldType:

`fieldType`	Returned value
`text`	`string`
`date`	object with keys `year`, `month`, `day` (all `number`)
`integer`	`number`
`multiple_choice`	`string` (guaranteed to be one of the values in `choices` or returned by `choiceGenerator`)
`calendar_slot`	ISO-8601 datetime string (e.g. `"2022-12-25T16:30"`)

You can call getField() at any point after the field has been collected — not just in onTaskComplete. Use it in mid-call callbacks to personalize subsequent steps.

Getting started

Agent SDK

CLI reference

WebRTC

SIP calling

Phone numbers

Deployments

Compliance

Release notes

Return types by field type

​Return types by field type

Return types by field type