Get Agent Run Status

GET

/api/public/ai-chat/agent-runs/{runId}/status

Returns the current status of an agent run started via POST /api/public/ai-chat/agents/{agentId}/runs. When status is done, output contains the assistant response text and files contains any downloadable files created by the run. Download URLs are short-lived; call this endpoint again if a URL expires. When status is failed, error describes the failure.

const url = 'https://backend.podscribe.ai/api/public/ai-chat/agent-runs/1/status';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://backend.podscribe.ai/api/public/ai-chat/agent-runs/1/status"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())

curl --request GET \
  --url https://backend.podscribe.ai/api/public/ai-chat/agent-runs/1/status \
  --header 'Authorization: Bearer <token>'

Path Parameters

runId

required

integer

(≥ 1)

Run ID returned by POST /api/public/ai-chat/agents/{agentId}/runs.

Response Body

Agent run status

application/json

runId

required

ID of the agent run.

integer

status

required

Current state of the run.

processing done failed

output

Assistant response text when status is done.

string

files

Files created by the run when status is done.

Array<{fileId,fileName,fileType,2 more}>

fileId

required

ID of the file.

string

fileName

required

File name, including the extension.

string

fileType

required

File extension: csv, tsv, txt, xls, xlsx, json, html or zip.

csv tsv txt xls xlsx json html zip

3 moreLess

size

required

File size in bytes.

integer

(≥ 0)

downloadUrl

required

Short-lived URL for downloading the file.

string<uri>

error

Error message when status is failed.

string

Response example

{
  "status": "processing",
  "files": [
    {
      "fileType": "csv"
    }
  ]
}