Poll Run Pipeline

GET /pipelines/run/${pipelineId}?jobId=${jobId}

Poll to retrieve the transforms

Request

Headers

An API Key is required to access this endpoint.

Name	Value
x-api-key	your_api_key

Polling response

The API returns the response in JSON format.

The request will return a 200 with the jobId, result and status. The result also includes the request parameters used to generate the transforms.

Example

200

{
  "jobId": "093ae7d8-1668-4c76-9f31-772c50bcb172",
  "result": {
    "restaurant_id": "d9504261cc66", 
    "review": "This place was really good. Highly recommend it. We had the steak, chicken and prawns. All super good. I would love it if they peeled the shrimp but it was flavorful. They changed out the grill once for us as it got sticky. We had the potstickers as appetizers. You definitely come out full but make sure you eat all the beef or they will charge you $40 if you leave any.",
    "sentiment": "POSITIVE",
    "translated_sentiment": "POSITIVO"
  },
  "status": "COMPLETE"
}

400

{
  "error": "Invalid request"
}

Webhook response

The webhook sends back a JSON response when the transforms for each API request are done.

The request will return a 200 with the result. The result also includes the request parameters used to generate the transforms.

Example

200

{
  "result": {
    "restaurant_id": "d9504261cc66", 
    "review": "This place was really good. Highly recommend it. We had the steak, chicken and prawns. All super good. I would love it if they peeled the shrimp but it was flavorful. They changed out the grill once for us as it got sticky. We had the potstickers as appetizers. You definitely come out full but make sure you eat all the beef or they will charge you $40 if you leave any.",
    "sentiment": "POSITIVE",
    "translated_sentiment": "POSITIVO"
  },
}

400

{
  "error": "Invalid request"
}