Get Run
Retrieve a single workflow run by ID
Retrieve a single workflow run by ID
Returns the full run record including status, transcript, recording URL, gathered context, and usage/cost info. Use recording_url and transcript_url to download artifacts, or use the Download endpoint for time-limited public URLs.
Quick reference#
Retrieve a single workflow run by ID. Send the request to GET /api/v1/workflow/{workflowid}/runs/{runid} on the Paladin API base URL.
| Method | GET |
|---|---|
| Path | /api/v1/workflow/{workflowid}/runs/{runid} |
| Path parameters | workflowid, runid |
| Authentication | Use the authentication method shown in the OpenAPI block and the Authentication docs. Keep API keys server-side. |
Before you call#
- Confirm you are using the production base URL shown in the API reference.
- Make sure any path IDs belong to the same Paladin organization as the credential you are using.
- Validate request bodies and required fields before sending production traffic.
Common error checks#
- Use 401 or 403 responses to check credentials, organization scope, and permissions.
- Use 404 responses to check whether the referenced resource exists in the current organization.
- Use 422 responses to inspect missing or invalid request fields.
OpenAPI#
GET /api/v1/workflow/{workflowid}/runs/{runid}
openapi: 3.1.0
info:
title: Paladin API
description: API for the Paladin app
version: 1.0.0
servers:
- url: https://app.paladin.northmanngrp.com
description: Production
security: []
paths:
/api/v1/workflow/{workflow_id}/runs/{run_id}:
get:
tags:
- main
summary: Get Workflow Run
operationId: get_workflow_run_api_v1_workflow__workflow_id__runs__run_id__get
parameters:
- name: workflow_id
in: path
required: true
schema:
type: integer
title: Workflow Id
- name: run_id
in: path
required: true
schema:
type: integer
title: Run Id
- name: authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
- name: X-API-Key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowRunResponseSchema'
'404':
description: Not found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
WorkflowRunResponseSchema:
properties:
id:
type: integer
title: Id
workflow_id:
type: integer
title: Workflow Id
name:
type: string
title: Name
mode:
type: string
title: Mode
created_at:
type: string
format: date-time
title: Created At
is_completed:
type: boolean
title: Is Completed
transcript_url:
anyOf:
- type: string
- type: 'null'
title: Transcript Url
recording_url:
anyOf:
- type: string
- type: 'null'
title: Recording Url
transcript_public_url:
anyOf:
- type: string
- type: 'null'
title: Transcript Public Url
recording_public_url:
anyOf:
- type: string
- type: 'null'
title: Recording Public Url
public_access_token:
anyOf:
- type: string
- type: 'null'
title: Public Access Token
cost_info:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Cost Info
definition_id:
anyOf:
- type: integer
- type: 'null'
title: Definition Id
initial_context:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Initial Context
gathered_context:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Gathered Context
call_type:
$ref: '#/components/schemas/CallType'
logs:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Logs
annotations:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Annotations
type: object
required:
- id
- workflow_id
- name
- mode
- created_at
- is_completed
- transcript_url
- recording_url
- cost_info
- definition_id
- call_type
title: WorkflowRunResponseSchema
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
CallType:
type: string
enum:
- inbound
- outbound
title: CallType
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError