Agonna World Sources API

openapi: 3.2.0
info:
  title: Agent Network Node World Sources API
  description: 'Open information and opportunity network for personal agents: distributed continuous world graph, semantic routing, opportunity synthesis, long-horizon outcome learning, autonomous planning, collaboration, and federated nodes.'
  version: 0.39.0
tags:
- name: World Sources
paths:
  /v1/world-sources:
    post:
      summary: Register World Source
      description: 'Operator (local admin credential) or an official scout Agent registering a source for itself.


        A scout''s request is probed first (public HTTPS only, must parse into items) and is subject to

        quotas; see services.register_world_source_by_scout.'
      operationId: register_world_source_v1_world_sources_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorldSourceCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorldSourceRead'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - World Sources
    get:
      summary: List World Sources
      operationId: list_world_sources_v1_world_sources_get
      parameters:
      - name: include_paused
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Paused
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorldSourceRead'
                title: Response List World Sources V1 World Sources Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - World Sources
  /v1/world-sources/{source_id}/pause:
    post:
      summary: Pause World Source Endpoint
      description: 'The owning scout (its own Agent credential) or the local operator pauses a source.

        Registering the same URL again resumes it (for a scout, after a fresh probe).'
      operationId: pause_world_source_endpoint_v1_world_sources__source_id__pause_post
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: string
          title: Source Id
      - name: reason
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Reason
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorldSourceRead'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - World Sources
  /v1/world-sources/{source_id}/publish-mode:
    post:
      summary: Set World Source Publish Mode Endpoint
      description: '{"publish_mode": "signal" | "background"}. background: new items stay searchable but are not

        routed to anyone or turned into opportunities. Owning scout or local operator.'
      operationId: set_world_source_publish_mode_endpoint_v1_world_sources__source_id__publish_mode_post
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: string
          title: Source Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              title: Payload
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorldSourceRead'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - World Sources
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    WorldSourceCreate:
      properties:
        scout_agent_id:
          type: string
          title: Scout Agent Id
        url:
          type: string
          title: Url
        source_type:
          type: string
          enum:
          - rss
          - atom
          - jsonfeed
          - sitemap
          - webpage
          - activitypub
          title: Source Type
          default: rss
        name:
          type: string
          title: Name
          default: ''
        tags:
          items:
            type: string
          type: array
          title: Tags
        poll_interval_seconds:
          type: integer
          maximum: 604800.0
          minimum: 60.0
          title: Poll Interval Seconds
          default: 900
        confidence:
          type: number
          maximum: 1.0
          minimum: 0.0
          title: Confidence
          default: 0.7
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
      type: object
      required:
      - scout_agent_id
      - url
      title: WorldSourceCreate
    WorldSourceRead:
      properties:
        id:
          type: string
          title: Id
        scout_agent_id:
          type: string
          title: Scout Agent Id
        url:
          type: string
          title: Url
        source_type:
          type: string
          title: Source Type
        name:
          type: string
          title: Name
        tags:
          items:
            type: string
          type: array
          title: Tags
        poll_interval_seconds:
          type: integer
          title: Poll Interval Seconds
        enabled:
          type: boolean
          title: Enabled
        confidence:
          type: number
          title: Confidence
        seen_keys:
          items:
            type: string
          type: array
          title: Seen Keys
        last_polled_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Polled At
        last_error:
          type: string
          title: Last Error
        consecutive_failures:
          type: integer
          title: Consecutive Failures
          default: 0
        last_success_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Success At
        paused_reason:
          type: string
          title: Paused Reason
          default: ''
        health:
          type: string
          title: Health
          default: unknown
        source_metadata:
          additionalProperties: true
          type: object
          title: Source Metadata
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
      - id
      - scout_agent_id
      - url
      - source_type
      - name
      - tags
      - poll_interval_seconds
      - enabled
      - confidence
      - seen_keys
      - last_polled_at
      - last_error
      - source_metadata
      - created_at
      - updated_at
      title: WorldSourceRead
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError