SyncStart a run now

Start a run now

Trigger every in-scope connection immediately.

A RUNNING run blocks this with 409 run_in_flight — it owns live Airbyte jobs, and a second run would stack a duplicate sync on each of them. A HELD run does not block: a hold is a run parked waiting for a person, and that person asking for a fresh run IS the decision, so the held run is closed as skipped (superseded) and a new one starts.

Runs are one per client per day, so a same-day rerun returns 409 run_exists_today — retry the failed steps instead. Requires ak_.

curl -X POST "https://mythic-analytics.gulp.workers.dev/client/v1/airbyte/pipelines/example_string/runs" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "run_id": "example_string",
    "client_id": "example_string",
    "run_date": "2024-12-25",
    "status": "running",
    "complete": true,
    "forced": true,
    "held_reason": "example_string",
    "triggered_by": "schedule",
    "started_at": "2024-12-25T10:00:00Z",
    "finished_at": "2024-12-25T10:00:00Z",
    "totals": {
      "total": 42,
      "succeeded": 42,
      "failed": 42,
      "skipped": 42,
      "records_committed": 42
    },
    "connections": [
      {
        "connection_id": "example_string",
        "name": "John Doe",
        "platform": "example_string",
        "status": "pending",
        "reason": "example_string",
        "job_id": 123,
        "records": 42,
        "bytes": 42,
        "duration_seconds": 42,
        "first_time": true,
        "last_success_at": "2024-12-25T10:00:00Z"
      }
    ]
  }
}
POST
/pipelines/{clientId}/runs
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Agency key as bearer token, format Bearer ak_.... Grants full read-write access scoped to the agency. Agency-wide scoped keys (mcp_ with no fixed location) are accepted too and need airbyte:read or airbyte:write; a client-bound mcp_ key gets 403 agency_key_required. See Using an mcp_ key over HTTP.

Agency key as bearer token, format Bearer ak_.... Grants full read-write access scoped to the agency. Agency-wide scoped keys (mcp_ with no fixed location) are accepted too and need airbyte:read or airbyte:write; a client-bound mcp_ key gets 403 agency_key_required. See Using an mcp_ key over HTTP.
Bearer Token
Bearer Tokenstring
Required

Location secret key as bearer token, format Bearer sk_.... Grants read-only access; the agency is resolved from the location. Write endpoints return 403.

Location secret key as bearer token, format Bearer sk_.... Grants read-only access; the agency is resolved from the location. Write endpoints return 403.
path
clientIdstring
Required

Client (location) identifier the pipeline belongs to.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Agency key as bearer token, format Bearer ak_.... Grants full read-write access scoped to the agency. Agency-wide scoped keys (mcp_ with no fixed location) are accepted too and need airbyte:read or airbyte:write; a client-bound mcp_ key gets 403 agency_key_required. See Using an mcp_ key over HTTP.

header
Authorizationstring
Required

Bearer token. Location secret key as bearer token, format Bearer sk_.... Grants read-only access; the agency is resolved from the location. Write endpoints return 403.

Path Parameters

clientIdstring
Required

Client (location) identifier the pipeline belongs to.

Responses

successboolean
dataobject

One client's syncs for one day. Also the body of the completion webhook, under data.