Calendar: Check Availability Tool

Usage

All Portia tools using API endpoints that require OAuth are built with plug and play authentication support. They use Portia client credentials including client ID, client name and redirect URL. Such tools will raise a Action Clarification with an OAuth link as the action URL. The portia.wait_for_ready() method must be used in this scenario: Portia's OAuth server will listen for the authentication result and resolve the concerned clarification, allowing your plan run to resume again.

For more on this, please visit to the section on running Portia tools (↗).

Tool details

Tool ID: portia:google:gcalendar:check_availability

Tool description: Checks the availability of this authenticated user for a given time range. DO NOT use this to validate availability of people the user wants to meet with. DO NOT use this unless the user specifically asks for availability checking, e.g by saying 'find when I am free', or 'check my availability'. Either the day, end_time, or start_time must be provided. Pay close attention to the task if it says 'before' or 'after'.

Args schema:

{
  "description": "Schema for checking Google Calendar availability.",
  "properties": {
    "email": {
      "description": "Email address to check availability for",
      "title": "Email",
      "type": "string"
    },
    "start_time": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Start time to check availability in ISO format, e.g 2024-09-20T20:00:00Z",
      "title": "Start Time"
    },
    "end_time": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "End time to check availability in ISO format, can be omitted e.g 2024-09-20T20:00:00Z",
      "title": "End Time"
    },
    "day": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The day to check availability for in ISO format, e.g 2024-09-20.",
      "title": "Day"
    }
  },
  "required": [
    "email"
  ],
  "title": "GoogleCalendarCheckAvailabilitySchema",
  "type": "object"
}

Output schema:

('list[dict[str, str]]', 'Returns a list of times when the user is available.')