shipshapedata-com Batch API

openapi: 3.2.0
info:
  title: Shipshape Data Batch API
  version: 1.1.0
  summary: Public read API for Shipshape Data, a London AI consultancy
  description: 'Keyless, read-only API for Shipshape Data (shipshapedata.com): services, industries, case studies with real outcomes, a cursor-paginated searchable library of 169 practical guides on data and AI, and the 16-question AI readiness assessment with server-side scoring. No authentication except the bulk export (free self-serve OAuth, see https://shipshapedata.com/auth.md). Open CORS, no write endpoints. Fair use is 300 requests/minute/IP, advertised via draft RateLimit headers (429 + Retry-After beyond it). All endpoints are stateless, so every request is idempotent; send an Idempotency-Key header and it is echoed back with Idempotency-Status. Versioning and deprecation policy: the version lives in the URL (/v1); breaking changes only ever ship as a new versioned path, deprecated versions keep working for at least 6 months and respond with Deprecation and Sunset headers for their final period (nothing is deprecated today; policy at https://shipshapedata.com/developers/). MCP servers offering the same capabilities: https://shipshapedata.com/mcp (product) and https://shipshapedata.com/mcp/docs (docs); NLWeb endpoint at https://shipshapedata.com/ask; A2A agent card at https://shipshapedata.com/.well-known/agent-card.json.'
  contact:
    name: Shipshape Data
    email: hello@shipshapedata.com
    url: https://shipshapedata.com/developers/
  termsOfService: https://shipshapedata.com/terms-of-use/
servers:
- url: https://shipshapedata.com/api
  description: Production
- url: https://shipshapedata.com/api/sandbox
  description: 'Sandbox: identical endpoints and data; every call is stateless and side-effect free, responses carry X-Sandbox: true'
tags:
- name: Batch
paths:
  /v1/batch:
    post:
      operationId: batchRequests
      summary: Run up to 20 GET requests in one call
      description: 'Bulk read: send a list of GET paths (with query strings) and receive each result in order. Useful for fetching services, case studies, and categories in a single round trip.'
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - requests
              properties:
                requests:
                  type: array
                  maxItems: 20
                  items:
                    type: object
                    required:
                    - path
                    properties:
                      path:
                        type: string
                        description: A GET path, e.g. /v1/services or /v1/resources?q=lineage
            example:
              requests:
              - path: /v1/services
              - path: /v1/case-studies
              - path: /v1/resources?q=governance&limit=3
      responses:
        '200':
          description: Per-request results in order
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
      tags:
      - Batch
components:
  responses:
    BadRequest:
      description: Invalid input
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    BatchResponse:
      type: object
      required:
      - responses
      properties:
        responses:
          type: array
          items:
            type: object
            required:
            - path
            - status
            - body
            properties:
              path:
                type: string
              status:
                type: integer
              body:
                type: object
                description: The same shape the GET endpoint returns, or an Error object on 404
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
            message:
              type: string
            docs:
              type: string
              format: uri
            openapi:
              type: string
              format: uri
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        pattern: ^[A-Za-z0-9._-]{1,255}$
      description: Optional client-chosen key. Every endpoint is stateless and side-effect free, so identical requests always produce identical results; the key is echoed back with an Idempotency-Status header so clients can confirm safe replay.
  securitySchemes:
    shipshapeOAuth:
      type: oauth2
      description: 'Free, self-serve client credentials: register at /oauth/register (open, anonymous), then exchange for a bearer token. Only the bulk export needs it.'
      flows:
        clientCredentials:
          tokenUrl: https://shipshapedata.com/oauth/token
          scopes:
            export: Read the complete dataset in one call