Agent Operations

Run a deployed Agent

Execute an agent by sending the provided message to the agent service. Returns a detailed response containing the conversation messages, logs, and metadata.

post/v1/agents/run

Request body

agent_idstring required

Unique identifier for the agent.

thread_idstring nullable

Unique identifier for the chat session.

hitl_decision'approve' | 'edit' | 'reject' nullable

Human-in-the-loop decision for the agent.

Response

Successful Response

responseobject[] required

Changes

Changed in 5 of the 23 revisions of this API.1824

  • 3517ca6a2c0411See the full diff
    • removed subschema #1 from the request property anyOf list

      request-property-any-of-removed

    • added subschema #1 subschema #2 to the request property anyOf list

      request-property-any-of-added

  • 536abd065ab0138See the full diff
    • the request property type changed from string to no type

      request-property-type-changed

    • the response property / became optional for the status

      response-property-became-optional

    • the response property /// became optional for the status

      response-property-became-optional

    • the response property /// became optional for the status

      response-property-became-optional

    • the response property /// became optional for the status

      response-property-became-optional

    • the response property /// became optional for the status

      response-property-became-optional

    • the response property / became optional for the status

      response-property-became-optional

    • the response property / became optional for the status

      response-property-became-optional

    • response property additional_metadata/thread_id list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property response/items/additionalProperties/llmresponse list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property response/items/additionalProperties/reasoning list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • the //// response's property type changed from string to no type for status

      response-property-type-changed

    • removed the required property ///// from the response with the status

      response-required-property-removed

    • added the new optional request property

      new-optional-request-property

    • added subschema #1 subschema #2 to the request property anyOf list

      request-property-any-of-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

    • the response's property default value was added for the status

      response-property-default-value-added

    • the response's property default value was added for the status

      response-property-default-value-added

    • the response's property default value 0 was added for the status

      response-property-default-value-added

  • c9a09aaa623615See the full diff
    • the response's body type changed from no type to object for status

      response-body-type-changed

    • added the new optional request property

      new-optional-request-property

    • added the optional property to the response with the status

      response-optional-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the response's body type changed from object to no type for status

      response-body-type-changed

    • removed the required property from the response with the status

      response-required-property-removed

    • added the new optional request property

      new-optional-request-property

    • removed the non-success response with the status

      response-non-success-status-removed

    • removed the non-success response with the status

      response-non-success-status-removed

    • removed the non-success response with the status

      response-non-success-status-removed

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f8b1d57c6f9616See the full diff
    • the response's body type changed from no type to object for status

      response-body-type-changed

    • the endpoint scheme security BearerAuth was added to the API

      api-security-added

    • api tag Agent Operations added

      api-tag-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the required property to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog