Run shell command

Execute a shell command within the session context and return the AI's response.

post/session/{sessionID}/shell

Path parameters

sessionIDstring required

Session ID

Query parameters

directorystring

Request body

agentstring required
commandstring required

Response

Created message

idstring required
sessionIDstring required
role'assistant' required
parentIDstring required
modelIDstring required
providerIDstring required
modestring required
agentstring required
summaryboolean
costnumber required
{"stackTrail":"components:schemas:AssistantMessage:properties:structured","oasType":"schema","type":"unknown"}
variantstring
finishstring
stepCappedboolean
stuckNudgedboolean
stuckAbortedboolean

Changes

Changed in 7 of the 102 revisions of this API.49

    • added the optional property stuckAborted to the response with the 200 status

      response-optional-property-added

    • added the optional property stuckNudged to the response with the 200 status

      response-optional-property-added

    • added the optional property stepCapped to the response with the 200 status

      response-optional-property-added

    • added the optional property structured to the response with the 200 status

      response-optional-property-added

    • added StructuredOutputError to the error response property anyOf list for the response status 200

      response-property-any-of-added

    • added the optional property tokens/total to the response with the 200 status

      response-optional-property-added

    • added ContextOverflowError to the error response property anyOf list for the response status 200

      response-property-any-of-added

    • added the optional property variant to the response with the 200 status

      response-optional-property-added

  • c7ae6a68e4fb41See the full diff
    • removed the optional property stepCapped from the response with the 200 status

      response-optional-property-removed

    • removed the optional property structured from the response with the 200 status

      response-optional-property-removed

    • removed the optional property tokens/total from the response with the 200 status

      response-optional-property-removed

    • removed the optional property variant from the response with the 200 status

      response-optional-property-removed

    • removed StructuredOutputError ContextOverflowError from the error response property anyOf list for the response status 200

      response-property-any-of-removed

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