Agents

Execute Agent Completion

Execute a single agent completion with the specified task. Supports both standard and streaming responses.

post/v1/agent/completions

Headers

x-api-keystring required

Request body

taskstring nullable

The task to be completed by the agent.

imgstring nullable

A base64 encoded image for the agent to process. Encode your image file to base64 and pass it here.

imgsstring[] nullable

A list of base64 encoded images for the agent to process. Encode your image files to base64 and pass them here.

tools_enabledstring[] nullable

A list of tools that the agent should use to complete its task.

Response

Successful Response

job_idstring nullable

The unique identifier for the agent completion.

successboolean nullable

Indicates whether the agent completion was successful.

namestring nullable

The name of the agent.

descriptionstring nullable

A description of the agent or completion.

temperaturenumber nullable

The temperature setting used for the agent's response generation.

{"stackTrail":"components:schemas:AgentCompletionOutput:properties:outputs:anyOf","oasType":"schema","type":"unknown","title":"Outputs","description":"The outputs generated by the agent.","nullable":true}
usageobject nullable

Usage statistics or metadata for the agent completion.

timestampstring nullable

The timestamp when the agent completion was created.

Changes

Changed in 8 of the 52 revisions of this API.3346

    • added the new None enum value to the request property //

      request-property-enum-value-added

  • 0882a16375db14See the full diff
    • removed from the / request property anyOf list

      request-property-any-of-removed

    • added the new optional request property /

      new-optional-request-property

    • added subschema #3 to the / request property anyOf list

      request-property-any-of-added

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

      request-property-any-of-added

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

      request-property-any-of-added

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

  • dd6e1de072c711See the full diff
    • the // request property's min was set to 1.00

      request-property-min-set

    • the request property default value medium was removed

      request-property-default-value-removed

    • added the new optional request property /

      new-optional-request-property

    • added the new optional request property /

      new-optional-request-property

    • added the new optional request property /

      new-optional-request-property

    • the request property default value changed from true to false

      request-property-default-value-changed

    • the request property default value changed from gpt-4.1 to claude-sonnet-5

      request-property-default-value-changed

    • added the new optional request property ///

      new-optional-request-property

    • added the new optional request property ///

      new-optional-request-property

    • added the new optional request property ///

      new-optional-request-property

    • added the new optional request property ///

      new-optional-request-property

    • added the new optional request property ///

      new-optional-request-property

    • added the new optional request property ///

      new-optional-request-property

    • added the new optional request property ///

      new-optional-request-property

    • added the new optional request property ///

      new-optional-request-property

    • added the new optional request property ///

      new-optional-request-property

    • added the new optional request property ///

      new-optional-request-property

    • added the new optional request property ///

      new-optional-request-property

    • added the new optional request property /////

      new-optional-request-property

    • added the new optional request property /////

      new-optional-request-property

    • added the new optional request property /////

      new-optional-request-property

    • added the new optional request property /////

      new-optional-request-property

    • added the new optional request property /////

      new-optional-request-property

    • added the new optional request property /////

      new-optional-request-property

    • added the new optional request property /////

      new-optional-request-property

    • added the new optional request property /////

      new-optional-request-property

    • added the new optional request property /////

      new-optional-request-property

    • added the new optional request property /////

      new-optional-request-property

    • added the new optional request property /////

      new-optional-request-property

    • the request property default value changed from 10 to 30

      request-property-default-value-changed

    • the request property default value changed from 10 to 30

      request-property-default-value-changed

    • added the new minimal enum value to the request property //

      request-property-enum-value-added

    • added the new none enum value to the request property //

      request-property-enum-value-added

  • a4b2639c845e15See the full diff
    • removed the enum value minimal of the request property //

      request-property-enum-value-removed

    • the request property default value changed from 8192 to 16000

      request-property-default-value-changed

    • the request property default value changed from low to medium

      request-property-default-value-changed

    • added the new max enum value to the request property //

      request-property-enum-value-added

    • added the new ultra enum value to the request property //

      request-property-enum-value-added

    • added the new xhigh enum value to the request property //

      request-property-enum-value-added

  • 9666c890823b124See the full diff
    • request property // was restricted to a list of enum values

      request-property-became-enum

    • the // request property's max was set to 2.00

      request-property-max-set

    • the // request property's min was set to 0.00

      request-property-min-set

    • added the new high enum value to the request property //

      request-property-enum-value-added

    • added the new low enum value to the request property //

      request-property-enum-value-added

    • added the new medium enum value to the request property //

      request-property-enum-value-added

    • added the new minimal enum value to the request property //

      request-property-enum-value-added