Get a pipeline execution

curl --request GET \
  --url https://web-api.clerk.chat/public/pipelines/{pipelineId}/executions/{executionId} \
  --header 'apiKey: <api-key>'

import requests

url = "https://web-api.clerk.chat/public/pipelines/{pipelineId}/executions/{executionId}"

headers = {"apiKey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apiKey: '<api-key>'}};

fetch('https://web-api.clerk.chat/public/pipelines/{pipelineId}/executions/{executionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://web-api.clerk.chat/public/pipelines/{pipelineId}/executions/{executionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apiKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://web-api.clerk.chat/public/pipelines/{pipelineId}/executions/{executionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apiKey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://web-api.clerk.chat/public/pipelines/{pipelineId}/executions/{executionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apiKey"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "pipelineId": "00000000-0000-0000-0000-000000000000",
  "pipelineVersionId": "00000000-0000-0000-0000-000000000000",
  "status": "success",
  "pipelineName": "My Agent",
  "pipelineVersionNumber": 1,
  "startedAt": "2021-01-01T00:00:00.000Z",
  "finishedAt": "2021-01-01T00:00:01.000Z",
  "error": "<string>",
  "aiTokensUsed": 512,
  "nodesStarted": 3,
  "conversationHistory": {},
  "contactDetails": {},
  "environment": {},
  "triggeredBy": "message_received",
  "triggeredByEntityId": "00000000-0000-0000-0000-000000000000",
  "conversationId": "00000000-0000-0000-0000-000000000000",
  "nodesExecuted": [
    {
      "nodeName": "Greeting",
      "node": {
        "id": "1",
        "name": "Greeting",
        "staticId": "1",
        "isGoal": false,
        "goalName": "Booked appointment"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "startedAt": "2021-01-01T00:00:00.000Z",
      "finishedAt": "2021-01-01T00:00:01.000Z",
      "status": "success",
      "errorMessage": "<string>",
      "aiTokensUsed": 128,
      "input": {},
      "output": {}
    }
  ],
  "pipelineMessages": [
    {
      "sourceNode": {
        "id": "1",
        "name": "Greeting",
        "staticId": "1",
        "isGoal": false,
        "goalName": "Booked appointment"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "content": {},
      "messageType": "text",
      "sourceNodeExecutionId": "00000000-0000-0000-0000-000000000000",
      "created": "2021-01-01T00:00:00.000Z",
      "destinations": {}
    }
  ]
}

GET

public

pipelines

{pipelineId}

executions

{executionId}

Get a pipeline execution

curl --request GET \
  --url https://web-api.clerk.chat/public/pipelines/{pipelineId}/executions/{executionId} \
  --header 'apiKey: <api-key>'

import requests

url = "https://web-api.clerk.chat/public/pipelines/{pipelineId}/executions/{executionId}"

headers = {"apiKey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apiKey: '<api-key>'}};

fetch('https://web-api.clerk.chat/public/pipelines/{pipelineId}/executions/{executionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://web-api.clerk.chat/public/pipelines/{pipelineId}/executions/{executionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apiKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://web-api.clerk.chat/public/pipelines/{pipelineId}/executions/{executionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apiKey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://web-api.clerk.chat/public/pipelines/{pipelineId}/executions/{executionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apiKey"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "pipelineId": "00000000-0000-0000-0000-000000000000",
  "pipelineVersionId": "00000000-0000-0000-0000-000000000000",
  "status": "success",
  "pipelineName": "My Agent",
  "pipelineVersionNumber": 1,
  "startedAt": "2021-01-01T00:00:00.000Z",
  "finishedAt": "2021-01-01T00:00:01.000Z",
  "error": "<string>",
  "aiTokensUsed": 512,
  "nodesStarted": 3,
  "conversationHistory": {},
  "contactDetails": {},
  "environment": {},
  "triggeredBy": "message_received",
  "triggeredByEntityId": "00000000-0000-0000-0000-000000000000",
  "conversationId": "00000000-0000-0000-0000-000000000000",
  "nodesExecuted": [
    {
      "nodeName": "Greeting",
      "node": {
        "id": "1",
        "name": "Greeting",
        "staticId": "1",
        "isGoal": false,
        "goalName": "Booked appointment"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "startedAt": "2021-01-01T00:00:00.000Z",
      "finishedAt": "2021-01-01T00:00:01.000Z",
      "status": "success",
      "errorMessage": "<string>",
      "aiTokensUsed": 128,
      "input": {},
      "output": {}
    }
  ],
  "pipelineMessages": [
    {
      "sourceNode": {
        "id": "1",
        "name": "Greeting",
        "staticId": "1",
        "isGoal": false,
        "goalName": "Booked appointment"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "content": {},
      "messageType": "text",
      "sourceNodeExecutionId": "00000000-0000-0000-0000-000000000000",
      "created": "2021-01-01T00:00:00.000Z",
      "destinations": {}
    }
  ]
}

Authorizations

apiKey

string

header

required

Path Parameters

pipelineId

string<uuid>

required

The ID of the pipeline

executionId

string<uuid>

required

The ID of the pipeline execution

Response

The pipeline execution

Represents a full pipeline execution, including node executions and messages

string<uuid>

required

The ID of the pipeline execution

Example:

"00000000-0000-0000-0000-000000000000"

pipelineId

string<uuid>

required

The ID of the pipeline (agent)

Example:

"00000000-0000-0000-0000-000000000000"

pipelineVersionId

string<uuid>

required

The ID of the pipeline version that was executed

Example:

"00000000-0000-0000-0000-000000000000"

status

enum<string>

required

The status of the execution

Available options:

new,

running,

paused,

success,

failed

Example:

"success"

pipelineName

string

The name of the pipeline (agent)

Example:

"My Agent"

pipelineVersionNumber

number

The version number that was executed

Example:

1

startedAt

string<date-time>

When the execution started

Example:

"2021-01-01T00:00:00.000Z"

finishedAt

string<date-time> | null

When the execution finished

Example:

"2021-01-01T00:00:01.000Z"

error

string | null

The error message if the execution failed

aiTokensUsed

number

The number of AI tokens used during the execution

Example:

512

nodesStarted

number

The number of nodes started during the execution

Example:

3

conversationHistory

object

The conversation history captured during the execution

contactDetails

object

Details about the contact associated with the execution

environment

object

The environment variables available to the execution

triggeredBy

string | null

What triggered the execution

Example:

"message_received"

triggeredByEntityId

string | null

The ID of the entity that triggered the execution

Example:

"00000000-0000-0000-0000-000000000000"

conversationId

string<uuid> | null

The ID of the conversation associated with the execution

Example:

"00000000-0000-0000-0000-000000000000"

nodesExecuted

object[]

The node executions, ordered by start time

Show child attributes

pipelineMessages

object[]

The messages produced during the execution, ordered by creation time

Show child attributes

Messages

Calls

Contacts

Campaigns

Pipelines

Knowledge Base

Twilio

API Reference

Admin

Inboxes

Programs

Opt-outs

Get a pipeline execution

Authorizations

Path Parameters

Response