Golem.ai Analyses API v2 (2.0.0)

Create an analysis in the environment provided in the path.

The inputs of an analysis

An analysis is composed of multiple inputs. For each input, you must specify:

• the type of the input: is it the BODY (the main content)? An ATTACHMENT (a file)? Or another type for more information? (TICKET_TOPIC for example)
• the content type of the input: is it a file or simply text.

To specify the inputs, you have to build the inputs JSON array. Here is an example with all kinds of inputs:

[
  {
    "type": "BODY",
    "contentType": "file",
    "file_key": "file_1"
  },
  // another possibility is to use a text input as the main content
  // but you should have only one BODY input
  {
    "type": "BODY",
    "contentType": "text",
    "text": "Main content to analyse",
    "name": "Main content" // This is optional, but recommended
  },
  // if you have attachments, you can specify them
  {
    "type": "ATTACHMENT",
    "contentType": "file",
    "file_key": "attachment_1"
  },
  {
    "type": "ATTACHMENT",
    "contentType": "file",
    "file_key": "attachment_2"
  },
  // if you have more information that golem must analyse.
  {
    "type": "TICKET_TOPIC",
    "contentType": "text",
    "text": "Ticket topic",
    "name": "TICKET_TOPIC" // This is optional, but recommended
  }
]

This inputs array must be set in the payload field of the request. The request must be a multipart/form-data request, and payload is mandatory to describe the analysis. It contains a JSON object, with the inputs array, but also other fields, namely:

• metadata: a JSON object containing the metadata of the analysis. Metadata are data you might want to keep around on your analysis, for example to match it back to something on your end when you receive the result by webhook.
  • the inbox metadata is special: if you have multiple "inboxes" for your messages, you should set this field to the inbox of the message. It will open a lot of features in the Golem.ai console.
• name: a string containing the name of the analysis. This is optional, and by default is set to the filename of the first BODY file. If that file has a non-descriptive name, you should set this field.
• manualFinalStatusUpdate: a boolean indicating that the success or failure of the analysis must be confirmed by an external automation. If you're not sure if you need it, you don't need it.
• inputs: the array of inputs described above.

Get an analysis result according to a configured flow.

The result can be overridden by integrations, but unless explicitly told so, the result will contain the same payload sent to any webhook.

The payload is configured on Golem.ai side. If the output misses some information you see here but is absent from the result, it might be a misconfiguration.

This route allows a user to send feedback on an analysis. It uses the same payload as /analyses/{analysisId}/result which the user will need to modify to submit the correction. You can use feedbackURL in the resul's payload to send a feedback on the analysis you queried.