Sign in
agent

Create a task

Creates a new task and submits it to the agent for processing

post/api/v1/agent/{agentId}/task

Path parameters

agentIdstring required

Headers

authorizationstring

This is your JWT tolen

x-api-keystring

A valid API key

Request body

cancelUrlstring
successUrlstring
emailstring email
testboolean
dataobject required

Response

200

successboolean required
paymentRequiredboolean required
redirectTostring

Changes

Changed in 2 of the 10 revisions of this API.8115

  • 74bdfb8101cc8114See the full diff
    • ▲

      added the new required request property data

      new-required-request-property

    • ▲

      the task/id response's property type/format changed from string/uuid to string/ for status 200

      response-property-type-changed

    • ▲

      removed the required property proposal from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property task/mode from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property task/paymentState from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property task/type from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property task/workspaceId from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property workspace from the response with the 200 status

      response-required-property-removed

    • ●

      removed the request property task

      request-property-removed

    • ○

      api operation id agent.createDefaultTaskForAgent removed and replaced with agent.createTask

      api-operation-id-removed

    • ○

      added the new optional request property cancelUrl

      new-optional-request-property

    • ○

      added the new optional request property email

      new-optional-request-property

    • ○

      added the new optional request property successUrl

      new-optional-request-property

    • ○

      added the new optional request property test

      new-optional-request-property

    • ○

      added the optional property redirectTo to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property paymentRequired to the response with the 200 status

      response-required-property-added

    • ○

      added the required property task/agentId to the response with the 200 status

      response-required-property-added

    • ○

      added the required property task/cost to the response with the 200 status

      response-required-property-added

    • ○

      added the required property task/paymentComplete to the response with the 200 status

      response-required-property-added

    • ○

      added the required property task/paymentDetails to the response with the 200 status

      response-required-property-added

    • ○

      added the required property task/test to the response with the 200 status

      response-required-property-added

    • ○

      added the required property task/title to the response with the 200 status

      response-required-property-added

    • ○

      added the required property task/userId to the response with the 200 status

      response-required-property-added

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

  • 3b82b46ab1d21See the full diff
    • ○

      added the required property task/paymentState to the response with the 200 status

      response-required-property-added