API Specifications

API specs are YAML definitions for extracting data from REST APIs. They handle authentication, pagination, response processing, and incremental sync automatically.

When to Use

• Extract data from REST APIs (GET endpoints only)
• Build incremental sync workflows
• Handle complex pagination patterns
• Process nested JSON responses
• Chain multiple API calls with queues

Basic Structure

name: "My API"
description: "Data extraction from My API"

authentication:
  type: "static"
  headers:
    Authorization: "Bearer {secrets.api_token}"

defaults:
  state:
    base_url: "https://api.example.com/v1"
  request:
    headers:
      Accept: "application/json"

endpoints:
  users:
    description: "Fetch users"
    request:
      url: "{state.base_url}/users"
    response:
      records:
        jmespath: "data[]"
        primary_key: ["id"]

MCP Operations

Parse a Spec

{
  "action": "parse",
  "input": {"file_path": "/path/to/spec.yaml"}
}

Test Endpoints

{
  "action": "test",
  "input": {
    "connection": "MY_API",
    "endpoints": ["users"],
    "debug": true,
    "limit": 10
  }
}

Topics Reference

This skill includes detailed documentation for each aspect of API specification building:

Quick Reference

Authentication Types

Pagination Patterns

Variable Scopes

Full Documentation

See https://docs.slingdata.io/concepts/api-specs.md for complete reference.