Skip to content

Create Connection

Diving Deep?

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

POST /api/v1/connections/create

Create a new raw-data connection.

curl https://api.shipp.ai/api/v1/connections/create?api_key=$api_key -d '{
  "filter_instructions": "High Impact Moments from MLB",
}'

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

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    filter_instructions: "High Impact Moments from MLB",
  })
});

const result = await response.json();

import requests

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

params = {
    "api_key": api_key
}

payload = {
    "filter_instructions": "High Impact Moments from MLB",
}

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

Request body

{
  "filter_instructions": "string (required)"
}

Response (200)

{
  "connection_id": "01KFXTX1WDQ68A1GS77T1XJ5YB",
  "enabled": true,
  "name": "string",
  "description": "string"
}

Errors

  • 400: invalid JSON, empty body, or missing filter_instructions
  • 500: unexpected server error