Skip to main content
POST
/
v1
/
sendAPIResultToUser
Send API Result to User
curl --request POST \
  --url https://api.gominerva.com/v1/sendAPIResultToUser \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "investigationName": "My New Investigation",
  "jobId": "previous-api-call-job-id",
  "requestId": "previous-api-call-request-id",
  "userEmail": "user@myorganization.com"
}
'
{
  "investigationId": "unique-id-of-the-investigation",
  "status": 200,
  "message": "API result successfully cloned into user investigation.",
  "code": "success"
}

Authorizations

​
x-api-key
string
header
required

The uuidv4 API key associated with the MinervaAI account making the request.

Body

application/json
​
jobId
string
required

The unique identifier of the job that the result was run under. This will be the same ID that was used to query the API result via the Search Status API, and is also present in the Search Status API response body.

Maximum string length: 36
Example:

"job-id-of-api-result"

​
requestId
string
required

The unique identifier of the request that the result was run under. In each result of the Search Status API batch, there is an id which is the unique identifier of that result in the job.

Maximum string length: 36
Example:

"request-id-of-api-result"

​
investigationId
string

If a previous investigation was generated by another call to /sendAPIResultToUser, then that investigationId can be provided to perform the investigation assignment. Either investigationName or investigationId must be provided.

Maximum string length: 36
Example:

"existing-investigation-id"

​
investigationName
string

The plain text label of the investigation that this result should be assigned under. If the investigation does not exist in the user's investigations list, then it will be created. Otherwise, the investigation matching this label will be used as the bin to place the result in. The investigation date will be the same as the date on which the API result was initially generated. It is recommended to use something easy to identify for the investigator that will receive the API result, such as a date and/or specific batch metadata.

Maximum string length: 1024
Example:

"My Investigation Name"

​
userEmail
string

The email address of the user that should receive the API result in one of their investigation bins. If not provided, the result will be assigned to the requesting user.

Maximum string length: 256
Example:

"user@myorganization.com"

Response

API result successfully cloned into user investigation.

​
investigationId
string

The unique identifier of the investigation that contains the API result.

Example:

"unique-id-of-the-investigation"

​
status
integer
Example:

200

​
message
string
Example:

"API result successfully cloned into user investigation."

​
code
string
Example:

"success"