Get an agent run

JavaScript

import Profound from '@profoundai/client';

const client = new Profound({
  apiKey: process.env['PROFOUND_API_KEY'], // This is the default and can be omitted
});

const run = await client.agents.runs.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  agent_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});

console.log(run.id);

import os
from profound import Profound

client = Profound(
    api_key=os.environ.get("PROFOUND_API_KEY"),  # This is the default and can be omitted
)
run = client.agents.runs.retrieve(
    run_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    agent_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(run.id)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tryprofound.com/v1/agents/{agent_id}/runs/{run_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <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://api.tryprofound.com/v1/agents/{agent_id}/runs/{run_id}"

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

	req.Header.Add("X-API-Key", "<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://api.tryprofound.com/v1/agents/{agent_id}/runs/{run_id}")

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

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "error": {},
  "outputs": {},
  "steps": [
    {
      "node_id": "<string>",
      "node_type": "<string>",
      "title": "<string>",
      "status": "<string>",
      "elapsed_time": 123,
      "finished_at": "2023-11-07T05:31:56Z",
      "error_message": "<string>",
      "outputs": {}
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

agents

{agent_id}

runs

{run_id}

JavaScript

import Profound from '@profoundai/client';

const client = new Profound({
  apiKey: process.env['PROFOUND_API_KEY'], // This is the default and can be omitted
});

const run = await client.agents.runs.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  agent_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});

console.log(run.id);

import os
from profound import Profound

client = Profound(
    api_key=os.environ.get("PROFOUND_API_KEY"),  # This is the default and can be omitted
)
run = client.agents.runs.retrieve(
    run_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    agent_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(run.id)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tryprofound.com/v1/agents/{agent_id}/runs/{run_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <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://api.tryprofound.com/v1/agents/{agent_id}/runs/{run_id}"

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

	req.Header.Add("X-API-Key", "<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://api.tryprofound.com/v1/agents/{agent_id}/runs/{run_id}")

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

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "error": {},
  "outputs": {},
  "steps": [
    {
      "node_id": "<string>",
      "node_type": "<string>",
      "title": "<string>",
      "status": "<string>",
      "elapsed_time": 123,
      "finished_at": "2023-11-07T05:31:56Z",
      "error_message": "<string>",
      "outputs": {}
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Path Parameters

agent_id

string<uuid>

required

The ID of the agent that owns the run.

run_id

string<uuid>

required

The ID of the run to retrieve.

Query Parameters

verbose

boolean

default:false

Include each step's raw outputs payload in the execution trace.

Response

Successful Response

Status and result details for an agent run.

string<uuid>

required

Unique ID for the run.

agent_id

string<uuid>

required

Unique ID of the agent for this run.

status

enum<string>

required

Current status of the run.

Available options:

queued,

running,

succeeded,

failed,

cancelled,

skipped,

unknown

started_at

string<date-time> | null

When the run started, if it has started.

finished_at

string<date-time> | null

When the run finished, if it has completed.

error

Error · object | null

Error details, when the run fails and error information is available.

outputs

Outputs · object

Output values returned by the run, keyed by variable ID. This object conforms to schema.output from the agent detail response and is empty when no outputs are available.

steps

AgentRunStep · object[] | null

Ordered step-by-step execution trace — one entry per node that ran, in execution order. Always present once the run has executed a node; per-node outputs inside each step are included only when the request asks for verbose.

Show child attributes

⌘I

Overview

SDKs

Integrations

Agents

Organization

Categories

Prompts

Knowledge Bases

OpenAI Ads

Answers

Reports

Content Optimization

Authorizations

Path Parameters

Query Parameters

Response