Siren

Siren Operations API

The Operations API from Siren — 3 operation(s) for operations.

Documentation GitHub OpenAPI

Operations 3

POST /api/operations/{operationid}/cancel Cancel the operation represented by operationId #

GET /api/operations/{operationid}/status Get the status of a long-running operation #

GET /api/operations/{operationid}/stream Get the stream of a long-running operation #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/siren-io:siren-io-operations-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Siren Investigate REST Operations API
  version: '2026-10-14'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-14, then hand-corrected: 9 operation(s) read from the Siren Investigate REST API pages of docs.siren.io (each operation names its page in x-source). Operations the generator lifted from third-party examples (OpenWeatherMap, Elasticsearch, Search Guard) were removed. This is not the provider''s published contract; Siren has published no machine-readable contract that the pipeline could find.'
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-14'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://docs.siren.io/siren-platform-user-guide/16.0/siren-investigate/c_search-api.html
  - https://docs.siren.io/siren-platform-user-guide/16.0/siren-investigate/c_dashboard-api.html
  - https://docs.siren.io/siren-platform-user-guide/16.0/siren-investigate/c_reconciliation-api.html
  - https://docs.siren.io/siren-platform-user-guide/16.0/siren-investigate/c_refresh-fields-api.html
  - https://docs.siren.io/siren-platform-user-guide/16.0/siren-investigate/reconciliation.html
  - https://docs.siren.io/siren-platform-user-guide/16.0/siren-investigate/t_edit-entity-tables.html
  - https://docs.siren.io/siren-platform-user-guide/16.0/siren-investigate/t_jwt-config.html
  - https://docs.siren.io/siren-platform-user-guide/16.0/siren-investigate/c_status-api.html
  - https://docs.siren.io/siren-platform-user-guide/16.0/siren-investigate/c_health-api.html
servers:
- url: https://{siren-investigate-host}
  description: Customer self-hosted Siren Investigate instance
  variables:
    siren-investigate-host:
      default: localhost:5606
tags:
- name: Operations
paths:
  /api/operations/{operationid}/cancel:
    post:
      operationId: post_api_operations_operationid_cancel
      tags:
      - Operations
      summary: Cancel the operation represented by operationId
      x-source: https://docs.siren.io/siren-platform-user-guide/16.0/siren-investigate/c_refresh-fields-api.html
      parameters:
      - name: operationid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/operations/{operationid}/status:
    get:
      operationId: getOperationStatus
      tags:
      - Operations
      summary: Get the status of a long-running operation
      x-source: https://docs.siren.io/siren-platform-user-guide/16.0/siren-investigate/c_reconciliation-api.html
      parameters:
      - name: operationid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiOperationsOperationidIdResponse'
      x-evidence:
        kind: documentation
        note: path read as /api/operations/<uuid>/status in the page example
  /api/operations/{operationid}/stream:
    get:
      operationId: getOperationStream
      tags:
      - Operations
      summary: Get the stream of a long-running operation
      x-source: https://docs.siren.io/siren-platform-user-guide/16.0/siren-investigate/c_reconciliation-api.html
      parameters:
      - name: operationid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiOperationsOperationidIdResponse'
      x-evidence:
        kind: documentation
        note: path read as /api/operations/<uuid>/stream in the page example
components:
  schemas:
    GetApiOperationsOperationidIdResponse:
      type: object
      properties:
        status:
          type: string
          description: 'Current status of the operation: ''running'', ''done'', or ''error'''
        data:
          type: object
          description: 'The data object associated with the current status: ProgressData, ReconciliationResult, or ErrorData'