Skip to main content
POST
/
v1
/
agent
/
completions
{
  "job_id": "<string>",
  "success": true,
  "name": "<string>",
  "description": "<string>",
  "temperature": 123,
  "outputs": "<any>",
  "usage": {},
  "timestamp": "<string>"
}

Headers

x-api-key
string
required

Body

application/json
agent_config
object | null

The configuration of the agent to be completed.

task
string | null

The task to be completed by the agent.

history

The history of the agent's previous tasks and responses. Can be either a dictionary or a list of message objects.

img
string | null

An optional image URL that may be associated with the agent's task or representation.

imgs
string[] | null

A list of image URLs that may be associated with the agent's task or representation.

tools_enabled
string[] | null

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

Response

Successful Response

job_id
string | null

The unique identifier for the agent completion.

success
boolean | null
default:true

Indicates whether the agent completion was successful.

name
string | null

The name of the agent.

description
string | null

A description of the agent or completion.

temperature
number | null

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

outputs
any

The outputs generated by the agent.

usage
object | null

Usage statistics or metadata for the agent completion.

timestamp
string | null

The timestamp when the agent completion was created.

I