SUsuprsonic
Suprsonic

Agent API

Changed on

O-mega Unified Agent API: single endpoint for all capabilities.

Instead of calling separate endpoints, agents call this one endpoint and either name the capability they need with its params, or describe what they need in request and the system routes it. Either way it runs the capability's own handler and answers its envelope.

post/v1/agent

Request

Request body

capabilitystring nullable

Which capability to run, with its params.

paramsobject

The named capability's parameters.

requeststring nullable

What you need, in plain words, instead of capability and params: it is routed to the capability that serves it, its params are filled from the words, and it runs.

Response

The call's envelope: success, data (the capability's result), metadata, and credits_used (0 when the call did not succeed).

successboolean required
credits_usedinteger

Changes

  • 120f2dd4c855Revision changes
    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property default value {} was removed

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 9edc3bfe1b9cRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status