Skip to main content

Send requests for human review

Use our SDK or API to send requests for human review to gotoHuman. You can fully customize a review to fit your use case by creating your own form used for the review.

Create a review form​

First, make sure you created a form in our web app.
Pick dynamic form components to inject data with every request for review, or add components to collect reviewer's input and decisions.
The example SDK/API call shown in the form editor will show you your API key, the formId and the fields values accepted for your custom form.

Prepare​

Install our SDK

pip install gotohuman

Setup an environment variable with the API key shown in the form editor:

GOTOHUMAN_API_KEY=YOUR_API_KEY

If you're using a .env file, don't forget to load it:

from dotenv import load_dotenv
load_dotenv()

Initialize the SDK

gotoHuman = GotoHuman()

Send request​

Create a request with the formId of the form you created.
Pass the field values as shown in our form editor and optionally add some meta data.

  review = gotoHuman.create_review("YOUR_FORM_ID")
  review.add_field_data("exampleField1", value1)
  review.add_field_data("exampleField2", value2)
  review.add_meta_data("threadId", threadId)
  review.assign_to_users(["[email protected]"])
  try:
      response = review.send_request()
      print("Review sent successfully:", response)
  except Exception as e:
      print("An error occurred:", e)

formId​

Find the formId in the example SDK/API call shown for your created form in the form editor.

fields​

When creating your form in our web app, you add different components to show dynamic content or collect user input.
These added components determine the payload that you need to send with your request.
You can find the expected format in the example SDK/API call shown for your created form in the form editor.

tip

Fields that you don't send any value for will be hidden.

This is handy for optional fields, but also if you need a varying number of a type of field, e.g. 1-n text fields. Then add n fields and just send values for the ones needed during this run.

For text-based fields you might in some cases not have a value for a field, but still want it to be shown to allow user input. To do that, simply send an empty string.

meta​

Add additional data to your request that you will receive back in the webhook. Read more below.

assignTo​

Assign reviewers from your organization. Read more below.

Example request​

Given a urlLink (id: linkedin) and a text component (id: aiDraft) on your form, a request might look like this:

Create a request with the formId of the form you created.
Pass the field values as shown in our form editor and optionally add some meta data.

  review = gotoHuman.create_review("abcdef12345")
  review.add_field_data("linkedin", {
      "label": "Rodrigo G.",
      "url": "https://www.linkedin.com/in/rodrigog12/"
      })
  review.add_field_data("aiDraft", "Hey there, I saw...")
  try:
      response = review.send_request()
      print("Review sent successfully:", response)
  except Exception as e:
      print("An error occurred:", e)

Add additional meta data​

When a user is done reviewing and submits the form, you will receive a webhook. For convenience, you can add additional data to your request that you will receive back in the webhook. This could be an ID of your workflow run or of a conversation thread.
It could look like this:

Create a request with the formId of the form you created.
Pass the field values as shown in our form editor and optionally add some meta data.

  review = gotoHuman.create_review("abcdef12345")
  review.add_field_data(...)
  review.add_meta_data('threadId', 'oai-thread-443289')
  try:
      response = review.send_request()
      print("Review sent successfully:", response)
  except Exception as e:
      print("An error occurred:", e)

Assign reviewers​

To send a review request only to selected users of your organization, you can specify a list of email addresses of those users. Use the email address used when signing up for gotoHuman.
This feature is available in our Pro plan.

Preselected Options​

When using Buttons, Checkboxes, or Dropdowns in your review forms, you can also set default values that will be preselected.

  review.add_field_data("buttons", {
    "options": [
        {
            "id": "choice1",
            "label": "Choice 1"
        },
        {
            "id": "choice2",
            "label": "Choice 2"
        }
    ],
    "default": "choice2"
})
info

You can also send a default value if you defined fixed selectable options when creating your review form.