Skip to main content

Requests: Search 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 (↗).

Configure your Zendesk tools with Portia AI​

You will need to provide the subdomain of your Zendesk account to use with Portia AI. This is because Zendesk creates a unique subdomain for each account.

Configure access in Portia AI​

  1. Log into your Portia dashboard ↗
  2. Navigate to the Manage Org tab.
  3. Enter the subdomain of your Zendesk account. Your subdomain is the part of your Zendesk URL before the .zendesk.com domain. For example, if your Zendesk URL is https://portialabs.zendesk.com, your subdomain is portialabs.

You are now ready to call Zendesk tools on our cloud!

Tool details​

Tool ID: portia:zendesk:requests:search

Tool description: Search for requests in Zendesk. Returns a maximum of 100 requests. A request in Zendesk is intended to be initiated by or on behalf of end users e.g. a customer. A request may be paired with a ticket (an admin/agent perspective of the same request).

Args schema:

{
  "description": "Input schema for ZendeskSearchRequestsTool.",
  "properties": {
    "query": {
      "description": "The syntax and matching logic for the string is detailed in the Zendesk Support search reference.",
      "title": "Query",
      "type": "string"
    }
  },
  "required": [
    "query"
  ],
  "title": "ZendeskSearchRequestsToolSchema",
  "type": "object"
}

Output schema:

('application/json', 'application/json: Payload from API')