HumanFirst icon

HumanFirst

Call HumanFirst playbook API
Join our community

Actions13

Overview

This node integrates with the HumanFirst API to manage and interact with playbooks and related resources such as prompts, pipelines, and conversation data. Specifically, the "List Playbooks" operation retrieves all playbooks within a specified namespace.

Common scenarios where this node is beneficial include:

  • Automating retrieval of playbook lists for monitoring or reporting.
  • Integrating playbook data into workflows for further processing or decision-making.
  • Managing conversational AI assets programmatically.

Practical example:

  • A user wants to fetch all playbooks in their project namespace to display them in a dashboard or trigger subsequent automation based on available playbooks.

Properties

Name Meaning
Namespace The namespace (a required string) under which the playbooks are organized and listed.

Output

The output JSON contains the response from the HumanFirst API listing all playbooks in the given namespace. This typically includes an array of playbook objects with metadata about each playbook.

Example structure (simplified):

{
  "playbooks": [
    {
      "id": "playbook1",
      "name": "Example Playbook",
      "description": "Description of the playbook",
      ...
    },
    ...
  ]
}

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the HumanFirst API.
  • The node makes HTTP requests to the HumanFirst API endpoints.
  • Proper configuration of the API base URL and version is handled internally via credentials.
  • The "Namespace" input must be provided to scope the request.

Troubleshooting

  • Missing or invalid Namespace: The namespace parameter is required; ensure it is correctly set.
  • Authentication errors: If the API key is missing, invalid, or expired, the node will fail with authorization errors. Verify the API key credential.
  • API connectivity issues: Network problems or incorrect API base URLs can cause request failures.
  • Unexpected API responses: If the API changes or returns errors, the node outputs the error message in the JSON field.

Links and References

Discussion