NInimbleway
Agents

POST /v1/agents/run

Changed on

Execute WSA Realtime Endpoint

Request

  • Base URL
    https://sdk.nimbleway.com
  • URL
    https://sdk.nimbleway.com/v1/agents/run
  • Auth
    HTTP bearer

Request body

agentstring required
formatsstring[]

Response formats to include. All disabled by default.

localizationboolean
paramsobject required

Example request

{
  "formats": [
    "html",
    "markdown"
  ]
}

Response

Successful Response

status'success' | 'skipped' | 'fatal' | 'error' | 'postponed' | 'ignored' | 'rejected' | 'blocked' required

The status of the task.

status_codenumber

The HTTP status code of the task.

task_idstring required

Unique identifier for the task.

urlstring required

The final URL.

warningsstring[]

List of warnings generated during the task.

Example response

{
  "data": {
    "network_capture": [
      {
        "filter": {
          "resource_type": "document"
        },
        "results": [
          {
            "request": {
              "resource_type": "document"
            }
          }
        ]
      }
    ]
  }
}

Changes

  • b746af292a14Revision changes
    • warning

      removed the optional property //// from the response with the status

  • 0926a0595c5dRevision changes
    • info

      added the new links enum value to the request property /

    • info

      added the optional property / to the response with the status