Run Agent

POST /agui

Run Agent

cURL

curl --request POST \
  --url https://api.example.com/agui \
  --header 'Content-Type: application/json' \
  --data '
{
  "threadId": "<string>",
  "runId": "<string>",
  "state": "<unknown>",
  "messages": [
    {
      "id": "<string>",
      "content": "<string>",
      "role": "developer",
      "name": "<string>",
      "encryptedValue": "<string>"
    }
  ],
  "tools": [
    {
      "name": "<string>",
      "description": "<string>",
      "parameters": "<unknown>"
    }
  ],
  "context": [
    {
      "description": "<string>",
      "value": "<string>"
    }
  ],
  "forwardedProps": "<unknown>",
  "parentRunId": "<string>"
}
'

import requests

url = "https://api.example.com/agui"

payload = {
    "threadId": "<string>",
    "runId": "<string>",
    "state": "<unknown>",
    "messages": [
        {
            "id": "<string>",
            "content": "<string>",
            "role": "developer",
            "name": "<string>",
            "encryptedValue": "<string>"
        }
    ],
    "tools": [
        {
            "name": "<string>",
            "description": "<string>",
            "parameters": "<unknown>"
        }
    ],
    "context": [
        {
            "description": "<string>",
            "value": "<string>"
        }
    ],
    "forwardedProps": "<unknown>",
    "parentRunId": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    threadId: '<string>',
    runId: '<string>',
    state: '<unknown>',
    messages: [
      {
        id: '<string>',
        content: '<string>',
        role: 'developer',
        name: '<string>',
        encryptedValue: '<string>'
      }
    ],
    tools: [{name: '<string>', description: '<string>', parameters: '<unknown>'}],
    context: [{description: '<string>', value: '<string>'}],
    forwardedProps: '<unknown>',
    parentRunId: '<string>'
  })
};

fetch('https://api.example.com/agui', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/agui",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'threadId' => '<string>',
    'runId' => '<string>',
    'state' => '<unknown>',
    'messages' => [
        [
                'id' => '<string>',
                'content' => '<string>',
                'role' => 'developer',
                'name' => '<string>',
                'encryptedValue' => '<string>'
        ]
    ],
    'tools' => [
        [
                'name' => '<string>',
                'description' => '<string>',
                'parameters' => '<unknown>'
        ]
    ],
    'context' => [
        [
                'description' => '<string>',
                'value' => '<string>'
        ]
    ],
    'forwardedProps' => '<unknown>',
    'parentRunId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/agui"

	payload := strings.NewReader("{\n  \"threadId\": \"<string>\",\n  \"runId\": \"<string>\",\n  \"state\": \"<unknown>\",\n  \"messages\": [\n    {\n      \"id\": \"<string>\",\n      \"content\": \"<string>\",\n      \"role\": \"developer\",\n      \"name\": \"<string>\",\n      \"encryptedValue\": \"<string>\"\n    }\n  ],\n  \"tools\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"parameters\": \"<unknown>\"\n    }\n  ],\n  \"context\": [\n    {\n      \"description\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"forwardedProps\": \"<unknown>\",\n  \"parentRunId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/agui")
  .header("Content-Type", "application/json")
  .body("{\n  \"threadId\": \"<string>\",\n  \"runId\": \"<string>\",\n  \"state\": \"<unknown>\",\n  \"messages\": [\n    {\n      \"id\": \"<string>\",\n      \"content\": \"<string>\",\n      \"role\": \"developer\",\n      \"name\": \"<string>\",\n      \"encryptedValue\": \"<string>\"\n    }\n  ],\n  \"tools\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"parameters\": \"<unknown>\"\n    }\n  ],\n  \"context\": [\n    {\n      \"description\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"forwardedProps\": \"<unknown>\",\n  \"parentRunId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/agui")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"threadId\": \"<string>\",\n  \"runId\": \"<string>\",\n  \"state\": \"<unknown>\",\n  \"messages\": [\n    {\n      \"id\": \"<string>\",\n      \"content\": \"<string>\",\n      \"role\": \"developer\",\n      \"name\": \"<string>\",\n      \"encryptedValue\": \"<string>\"\n    }\n  ],\n  \"tools\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"parameters\": \"<unknown>\"\n    }\n  ],\n  \"context\": [\n    {\n      \"description\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"forwardedProps\": \"<unknown>\",\n  \"parentRunId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Body

application/json

Input for running an agent.

threadId · string · required

runId · string · required

state · any · required

messages · (DeveloperMessage · object | SystemMessage · object | AssistantMessage · object | UserMessage · object | ToolMessage · object | ActivityMessage · object | ReasoningMessage · object)[] · required

A developer message.

DeveloperMessage

SystemMessage

AssistantMessage

UserMessage

ToolMessage

ActivityMessage

ReasoningMessage

Show child attributes

tools · Tool · object[] · required

Show child attributes

context · Context · object[] · required

Show child attributes

forwardedProps · any · required

parentRunId · string | null

Response

200

application/json

Successful Response