Skip to content

Run Connection

Diving Deep?

This page is designed for AI Agents & users developing code directly. See Getting Started and Platform Guides

POST /api/v1/connections/{connection_id}

Run a connection and return raw event data.

Path params

  • connection_id (required): ULID of the connection

Body Params

  • since (string, ISO 8601 / RFC 3339, optional): A reference time to pull results starting from. Default: 48 hours ago
  • limit (int, optional): a limit of events to return. Default: 100
  • since_event_id (ULID, optional): the last id received, only sends data from newer events. Limit and since are respected. Causes events to be ordered asc by wall_clock_start time
curl https://api.shipp.ai/api/v1/connections/01KFXTX1WDQ68A1GS77T1XJ5YB?api_key=$api_key -d '{
  "since_event_id": "01KGE1JQG5HMR9A3AQHVZF9W37",
  "since": "2026-01-27T19:41:30Z",
  "limit": 10
}'

const apiKey = "YOUR_API_KEY_HERE";
const url = `https://api.shipp.ai/api/v1/connections/01KFXTX1WDQ68A1GS77T1XJ5YB?api_key=${apiKey}`;

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    since_event_id: "01KGE1JQG5HMR9A3AQHVZF9W37",
    since: "2026-01-27T19:41:30Z",
    limit: 10
  })
});

const result = await response.json();

import requests

url = "https://api.shipp.ai/api/v1/connections/01KFXTX1WDQ68A1GS77T1XJ5YB"
api_key = "YOUR_API_KEY_HERE"

params = {
    "api_key": api_key
}

payload = {
    "since_event_id": "01KGE1JQG5HMR9A3AQHVZF9W37",
    "since": "2026-01-27T19:41:30Z",
    "limit": 10
}

response = requests.post(url, json=payload, params=params)

Response (200)

{
  "connection_id": "01KFXTX1WDQ68A1GS77T1XJ5YB",
  "data": [
    { "any": "shape varies by feed + event data availability" }
  ]
}

Errors

  • 400: missing/invalid connection_id
  • 400: “Over Limit / Not Authorized” if billing/limits reject execution
  • 500: unexpected server error