Runs

Queue a run

Queues an acquisition of the source's current recipe version. Poll the run until it completes.

post/v1/sources/{source_id}/runs

Request

  • Base URL: https://sourcefinch.com
  • URL: https://sourcefinch.com/v1/sources/{source_id}/runs
  • Auth: HTTP bearer

Path parameters

source_idstring uuid required

Headers

Idempotency-Keystring

Makes retries safe for 24 hours. Reusing a key with a different request returns 422.

X-Request-Idstring

Echoed in the response and logs; generated when absent.

SourceFinch-Projectstring uuid

Project UUID. Required for session tokens; API keys are bound to their project.

Request body

object required

Empty body. Send an Idempotency-Key header to make retries safe.

Response

The queued run

idstring uuid required
source_idstring uuid required
source_versioninteger nullable required
status'queued' | 'running' | 'success' | 'degraded' | 'failed' | 'blocked' required
trigger'manual' | 'schedule' | 'api' required
attemptinteger required
created_atstring required

ISO-8601 timestamp (UTC)

completed_atstring nullable required

ISO-8601 timestamp (UTC)

errorstring nullable required
validationobject nullable required
healthobject nullable required
metricsobject nullable required
changesobject nullable required
acquisition_path'official_api' | 'bulk_file' | 'open_data_portal' | 'licensed_feed' | 'publisher_partnership' | 'pay_per_crawl' | 'public_web' | 'customer_authorized' | 'records_request' | 'manual_upload' required
failure_class'transient_network' | 'origin_5xx' | 'rate_limited' | 'robots_unavailable' | 'robots_disallowed' | 'blocked_challenge' | 'http_4xx' | 'payment_required' | 'redirect_blocked' | 'budget_exceeded' | 'policy_refused' | 'extraction_failed' | 'validation_failed' required
complianceobject nullable required

Compliance state at capture: acquisition path, usage rights, terms posture, robots.txt hash and verdict, AI/TDM signals, crawler identity, pay-per-crawl

Changes

No recorded changes to this operation across all 2 revisions of this API.