curl https://api.getguru.ai/automations/automation-123/invocations/invocation-123

{
    "id": "invocation-123",
    "created_at": "2024-01-01T00:00:00.000000+00:00",
    "files": [
        {
            "extension": "pdf",
            "file_id": "file-123",
            "url": "https://guru-automations-documents.s3.amazonaws.com/file-123.pdf?auth_parameters"
        }
    ],
    "finished_at": "2024-01-01T00:00:10.000000+00:00",
    "input": "raw file text",
    "output_url": "https://guru-automations-documents.s3.amazonaws.com/output-id.txt?auth_parameters",
    "status": "Complete"
}

Once an invocation has been initiated, you can fetch the status and output of it using the ID. It is expected that an invocation will take time to finish. While it is in progress, a status field will indicate it as Pending or Running. Once the invocation has finished, the status will be set to Complete.

GET https://api.getguru.ai/automations/<automation_id>/invocations/<invocation_id>

​
Request

​
automation_id
string

The ID of the automation that was invoked.

​
invocation_id
string

The ID of the invocation. This is the value returned when the invocation was initiated.

​
Response

​
id
string

The unique identifier for this invocation.

​
status
string

The status of the invocation. Possible values:

  • Pending: The invocation has been queued for execution.
  • Running: The invocation is currently running.
  • Complete: The invocation has finished successfully.
  • Failed: The invocation has finished unsuccessfully.
​
created_at
string

ISO-8601 timestamp indicating when the invocation began.

​
files
array

An array indicating the files that were used as input to the invocation, if any.

​
finished_at
string

If the invocation has completed, an ISO-8601 timestamp indicating when it completed.

​
input
string

The input to the invocation. If files were present, this will include data extracted from the files.

​
output_url
string

A presigned URL, from where the output of the invocation can be downloaded.

​
failure_reason
string

If status is Failed, then this field indicates the reason for the failure.

curl https://api.getguru.ai/automations/automation-123/invocations/invocation-123

{
    "id": "invocation-123",
    "created_at": "2024-01-01T00:00:00.000000+00:00",
    "files": [
        {
            "extension": "pdf",
            "file_id": "file-123",
            "url": "https://guru-automations-documents.s3.amazonaws.com/file-123.pdf?auth_parameters"
        }
    ],
    "finished_at": "2024-01-01T00:00:10.000000+00:00",
    "input": "raw file text",
    "output_url": "https://guru-automations-documents.s3.amazonaws.com/output-id.txt?auth_parameters",
    "status": "Complete"
}