Orchesty.io 3.0 API

openapi: 3.1.0
info:
  title: Orchesty.io 3.0 API
  version: '2026-10-18'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-18: 26 operation(s) read from 7 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Orchesty.io has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 10
    documentation: 24
    pages-with-code: 8
    pages-read: 13
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-18'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://orchesty.io/docs/3.0/development/operations/prefetch
  - https://orchesty.io/docs/3.0/development/operations/trace-auditing
  - https://orchesty.io/docs/3.0/development/operations/trash-inbox
  - https://orchesty.io/docs/3.0/pulse/for-agents/api-and-authentication
  - https://orchesty.io/docs/3.0/pulse/for-agents/manifest-and-run
  - https://orchesty.io/docs/3.0/pulse/overview
  - https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
  x-docs-section: '3.0'
paths:
  /api/nodes/{id}:
    patch:
      operationId: patch_api_nodes_id
      tags:
      - Api
      summary: Prefetch
      x-source: https://orchesty.io/docs/3.0/development/operations/prefetch
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchApiNodesIdRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/status:
    get:
      operationId: get_api_status
      tags:
      - Api
      summary: The bridge re-reads it from GET /api/status on its next refresh.
      x-source: https://orchesty.io/docs/3.0/development/operations/trash-inbox
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/topologies/{id}/nodes:
    get:
      operationId: get_api_topologies_id_nodes
      tags:
      - Api
      summary: Prefetch
      x-source: https://orchesty.io/docs/3.0/development/operations/prefetch
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/topologies/{id}/republish:
    post:
      operationId: post_api_topologies_id_republish
      tags:
      - Api
      summary: Prefetch
      x-source: https://orchesty.io/docs/3.0/development/operations/prefetch
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/topologies/{id}/run:
    post:
      operationId: post_api_topologies_id_run
      tags:
      - Api
      summary: Runs a topology.
      x-source: https://orchesty.io/docs/3.0/pulse/overview
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/topologies/{id}/unpublish:
    post:
      operationId: post_api_topologies_id_unpublish
      tags:
      - Api
      summary: Prefetch
      x-source: https://orchesty.io/docs/3.0/development/operations/prefetch
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /applications:
    get:
      operationId: get_applications
      tags:
      - Applications
      summary: List all Applications registered in this worker.
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /applications/authorize/token:
    get:
      operationId: get_applications_authorize_token
      tags:
      - Applications
      summary: Generic OAuth callback variant.
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /applications/{key}:
    get:
      operationId: get_applications_key
      tags:
      - Applications
      summary: Application detail (name, description, form definition).
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /applications/{key}/sync/list:
    get:
      operationId: get_applications_key_sync_list
      tags:
      - Applications
      summary: List the synchronous methods the Application exposes.
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /applications/{key}/sync/{method}:
    post:
      operationId: post_applications_key_sync_method
      tags:
      - Applications
      summary: Invoke one synchronous method (used for in-Admin lookups, e.g. populating a select box from upstream).
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      - name: method
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /applications/{key}/users/{user}/sdk/{sdk}/authorize:
    get:
      operationId: get_applications_key_users_user_sdk_sdk_authorize
      tags:
      - Applications
      summary: Build the authorize URL the user is redirected to.
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      - name: user
        in: path
        required: true
        schema:
          type: string
      - name: sdk
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /applications/{key}/users/{user}/sdk/{sdk}/authorize/token:
    get:
      operationId: get_applications_key_users_user_sdk_sdk_authorize_token
      tags:
      - Applications
      summary: Callback target the provider returns to.
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      - name: user
        in: path
        required: true
        schema:
          type: string
      - name: sdk
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /batch/list:
    get:
      operationId: get_batch_list
      tags:
      - Batch
      summary: List all batch nodes.
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /batch/{key}/action:
    post:
      operationId: post_batch_key_action
      tags:
      - Batch
      summary: Run one batch node iteration.
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBatchKeyActionRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostBatchKeyActionResponse'
      x-evidence:
        kind: documentation
  /batch/{key}/action/test:
    get:
      operationId: get_batch_key_action_test
      tags:
      - Batch
      summary: Same for a batch node.
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /connector/list:
    get:
      operationId: get_connector_list
      tags:
      - Connector
      summary: List all Connectors.
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /connector/{id}/action:
    post:
      operationId: post_connector_id_action
      tags:
      - Connector
      summary: Run one connector against an inbound message.
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostConnectorIdActionRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostConnectorIdActionResponse'
      x-evidence:
        kind: documentation
  /connector/{id}/action/test:
    get:
      operationId: get_connector_id_action_test
      tags:
      - Connector
      summary: Health-check this connector (does it even resolve)?
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /custom_node/list:
    get:
      operationId: get_custom_node_list
      tags:
      - Custom Node
      summary: List all custom nodes.
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /custom_node/{id}/process:
    post:
      operationId: post_custom_node_id_process
      tags:
      - Custom Node
      summary: Run one custom node against an inbound message.
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCustomNodeIdProcessRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCustomNodeIdProcessResponse'
      x-evidence:
        kind: documentation
  /custom_node/{id}/process/test:
    get:
      operationId: get_custom_node_id_process_test
      tags:
      - Custom Node
      summary: Same for a custom node.
      x-source: https://orchesty.io/docs/3.0/reference/platform/worker-rest-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /mcp/manifest.json:
    get:
      operationId: get_mcp_manifest_json
      tags:
      - Mcp
      summary: GET /mcp/manifest.json
      x-source: https://orchesty.io/docs/3.0/pulse/for-agents/api-and-authentication
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://your-instance.example.com/mcp/manifest.json  -H \"X-Auth: <AGENT_API_KEY>\"\n Each key is bound to a dedicated\
          \ agent user : a machine identity created when you mint the key. The rule is one key, one agent. The agent user is not a person and\
          \ cannot sign in to the UI; it exists only to carry the key's authorization. Agent keys are an Enterprise capability managed in the\
          \ admin UI under API "
    post:
      operationId: post_mcp_manifest_json
      tags:
      - Mcp
      summary: POST /mcp/manifest.json
      x-source: https://orchesty.io/docs/3.0/pulse/for-agents/manifest-and-run
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostMcpManifestJsonRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostMcpManifestJsonResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://your-instance.example.com/mcp/manifest.json  -H \"X-Auth: <AGENT_API_KEY>\"\n The response is a list of tools the\
          \ caller may use. Each topology tool looks like this: {\n \"id\" : \"topology:weather-report\" ,\n \"title\" : \"weather-report\" ,\n\
          \ \"description\" : \"Returns tomorrow's weather report for a city.\" ,\n \"kind\" : \"query\" ,\n \"input_schema\" : {\n \"type\" :\
          \ \"object\" ,\n \"properties\" : { \"city\" : {"
  /mcp/run:
    post:
      operationId: post_mcp_run
      tags:
      - Mcp
      summary: Runs a tool and returns the result, or starts an async query.
      description: Executes a permitted topology tool and returns its result, or initiates an asynchronous query.
      x-source: https://orchesty.io/docs/3.0/pulse/for-agents/api-and-authentication
      parameters:
      - name: X-Auth
        in: header
        required: true
        schema:
          type: string
        description: Static API key for the agent user (sent in the X-Auth header).
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /topologies/{id}/publish:
    post:
      operationId: post_topologies_id_publish
      tags:
      - Topologies
      summary: Trace auditing
      x-source: https://orchesty.io/docs/3.0/development/operations/trace-auditing
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PatchApiNodesIdRequest:
      type: object
      properties:
        prefetch:
          type: integer
          description: Prefetch value (1..20)
      required:
      - prefetch
    PostBatchKeyActionRequest:
      type: object
      properties:
        inbound ProcessDto:
          type: string
      required:
      - inbound ProcessDto
    PostBatchKeyActionResponse:
      type: object
      properties:
        outbound ProcessDto:
          type: object
    PostConnectorIdActionRequest:
      type: object
      properties:
        inbound ProcessDto:
          type: string
      required:
      - inbound ProcessDto
    PostConnectorIdActionResponse:
      type: object
      properties:
        outbound ProcessDto:
          type: object
    PostCustomNodeIdProcessRequest:
      type: object
      properties:
        inbound ProcessDto:
          type: string
      required:
      - inbound ProcessDto
    PostCustomNodeIdProcessResponse:
      type: object
      properties:
        outbound ProcessDto:
          type: object
    PostMcpManifestJsonRequest:
      type: object
      properties:
        tool:
          type: string
        args:
          type: object
          properties:
            city:
              type: string
    PostMcpManifestJsonResponse:
      type: object
      properties:
        type:
          type: string
        properties:
          type: object
          properties:
            city:
              type: object
              properties:
                type:
                  type: string
        required:
          type: array
          items:
            type: string
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      x-source: https://orchesty.io/docs/3.0/development/authentication-and-settings/authentication-and-settings
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.wflow.com/oauth/authorize
          tokenUrl: https://auth.wflow.com/oauth/token
          scopes:
            read_invoices: ''
            write_invoices: ''
      x-source: https://orchesty.io/docs/3.0/development/authentication-and-settings/authentication-and-settings
tags:
- name: Api
- name: Applications
- name: Batch
- name: Connector
- name: Custom Node
- name: Mcp
- name: Topologies
security:
- Bearer: []
- OAuth2:
  - read_invoices
  - write_invoices