Clarity Pipeline Runs API
The pipeline_runs API from Clarity — 4 operation(s) for pipeline_runs.
The pipeline_runs API from Clarity — 4 operation(s) for pipeline_runs.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/onclarity-com:onclarity-com-pipeline-runs-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Fast Pipeline Runs API
version: 0.1.0
tags:
- name: pipeline_runs
paths:
/api/v1/admin/projects/{project_id}/pipeline-runs/pending:
get:
tags:
- pipeline_runs
summary: List Pending
operationId: list_pending_api_v1_admin_projects__project_id__pipeline_runs_pending_get
security:
- HTTPBearer: []
parameters:
- name: project_id
in: path
required: true
schema:
type: integer
title: Project Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PendingResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/admin/projects/{project_id}/pipeline-runs:
post:
tags:
- pipeline_runs
summary: Start Run
operationId: start_run_api_v1_admin_projects__project_id__pipeline_runs_post
security:
- HTTPBearer: []
parameters:
- name: project_id
in: path
required: true
schema:
type: integer
title: Project Id
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/StartDailyRequest'
- $ref: '#/components/schemas/StartReinferenceRequest'
discriminator:
propertyName: kind
mapping:
daily: '#/components/schemas/StartDailyRequest'
reinference: '#/components/schemas/StartReinferenceRequest'
title: Body
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/StartRunResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- pipeline_runs
summary: List Runs
operationId: list_runs_api_v1_admin_projects__project_id__pipeline_runs_get
security:
- HTTPBearer: []
parameters:
- name: project_id
in: path
required: true
schema:
type: integer
title: Project Id
- name: limit
in: query
required: false
schema:
type: integer
maximum: 50
minimum: 1
default: 20
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RunList'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/admin/projects/{project_id}/pipeline-runs/{run_id}:
get:
tags:
- pipeline_runs
summary: Get Run
operationId: get_run_api_v1_admin_projects__project_id__pipeline_runs__run_id__get
security:
- HTTPBearer: []
parameters:
- name: project_id
in: path
required: true
schema:
type: integer
title: Project Id
- name: run_id
in: path
required: true
schema:
type: string
title: Run Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/src__pipeline_runs__schemas__RunStatus'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/admin/projects/{project_id}/pipeline-schedule:
get:
tags:
- pipeline_runs
summary: Get Schedule
operationId: get_schedule_api_v1_admin_projects__project_id__pipeline_schedule_get
security:
- HTTPBearer: []
parameters:
- name: project_id
in: path
required: true
schema:
type: integer
title: Project Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- pipeline_runs
summary: Set Schedule
operationId: set_schedule_api_v1_admin_projects__project_id__pipeline_schedule_put
security:
- HTTPBearer: []
parameters:
- name: project_id
in: path
required: true
schema:
type: integer
title: Project Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleBody'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
PendingResponse:
properties:
total:
type: integer
title: Total
oldest_day:
anyOf:
- type: string
format: date
- type: 'null'
title: Oldest Day
groups:
items:
$ref: '#/components/schemas/PendingGroup'
type: array
title: Groups
type: object
required:
- total
- oldest_day
- groups
title: PendingResponse
ScheduleResponse:
properties:
daily:
anyOf:
- type: string
- type: 'null'
title: Daily
other_schedules:
items:
type: string
type: array
title: Other Schedules
default: []
type: object
required:
- daily
title: ScheduleResponse
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
StartRunResponse:
properties:
run_id:
type: string
title: Run Id
kind:
type: string
title: Kind
status:
type: string
title: Status
started_at:
type: string
format: date-time
title: Started At
days_ago:
anyOf:
- type: integer
- type: 'null'
title: Days Ago
files_queued:
type: integer
title: Files Queued
files_skipped_processed:
type: integer
title: Files Skipped Processed
files_skipped_unknown:
type: integer
title: Files Skipped Unknown
type: object
required:
- run_id
- kind
- status
- started_at
- days_ago
- files_queued
- files_skipped_processed
- files_skipped_unknown
title: StartRunResponse
PendingGroup:
properties:
source_name:
type: string
title: Source Name
source_index:
type: string
title: Source Index
files:
type: integer
title: Files
oldest_day:
type: string
format: date
title: Oldest Day
newest_day:
type: string
format: date
title: Newest Day
type: object
required:
- source_name
- source_index
- files
- oldest_day
- newest_day
title: PendingGroup
src__pipeline_runs__schemas__RunStatus:
properties:
run_id:
type: string
title: Run Id
kind:
type: string
title: Kind
status:
type: string
title: Status
started_at:
type: string
format: date-time
title: Started At
stopped_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Stopped At
current_step:
anyOf:
- type: string
- type: 'null'
title: Current Step
error:
anyOf:
- type: string
- type: 'null'
title: Error
cause:
anyOf:
- type: string
maxLength: 1000
- type: 'null'
title: Cause
type: object
required:
- run_id
- kind
- status
- started_at
- stopped_at
- current_step
- error
- cause
title: RunStatus
StartReinferenceRequest:
properties:
kind:
type: string
const: reinference
title: Kind
query:
additionalProperties: true
type: object
title: Query
operator_ids:
items:
type: integer
type: array
maxItems: 50
minItems: 1
title: Operator Ids
label:
anyOf:
- type: string
maxLength: 20
pattern: ^[A-Za-z0-9-]+$
- type: 'null'
title: Label
type: object
required:
- kind
- query
- operator_ids
title: StartReinferenceRequest
ScheduleBody:
properties:
daily:
anyOf:
- type: string
- type: 'null'
title: Daily
type: object
required:
- daily
title: ScheduleBody
StartDailyRequest:
properties:
kind:
type: string
const: daily
title: Kind
files:
anyOf:
- items:
type: string
type: array
maxItems: 500
minItems: 1
- type: 'null'
title: Files
days_ago:
anyOf:
- type: integer
maximum: 3650.0
minimum: 1.0
- type: 'null'
title: Days Ago
type: object
required:
- kind
title: StartDailyRequest
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
RunList:
properties:
runs:
items:
$ref: '#/components/schemas/src__pipeline_runs__schemas__RunStatus'
type: array
title: Runs
type: object
required:
- runs
title: RunList
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
HTTPBasic:
type: http
scheme: basic