Dag Endpoint

Run a DAG planner pipeline with SSE progress updates.

Parameters

request : Request The incoming HTTP request; used to detect client disconnects. body : ChatStreamRequest JSON request body containing the query and optional parameters.

POST /api/dag

Dag Endpoint

cURL

curl --request POST \
  --url https://your-domain.com/api/dag \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "q": "<string>",
  "conversation_id": "<string>",
  "agent_id": "<string>",
  "token": "<string>",
  "image_ids": "<string>",
  "user_metadata": "<string>",
  "doc_mode": "<string>"
}
'

import requests

url = "https://your-domain.com/api/dag"

payload = {
    "q": "<string>",
    "conversation_id": "<string>",
    "agent_id": "<string>",
    "token": "<string>",
    "image_ids": "<string>",
    "user_metadata": "<string>",
    "doc_mode": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    q: '<string>',
    conversation_id: '<string>',
    agent_id: '<string>',
    token: '<string>',
    image_ids: '<string>',
    user_metadata: '<string>',
    doc_mode: '<string>'
  })
};

fetch('https://your-domain.com/api/dag', 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://your-domain.com/api/dag",
  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([
    'q' => '<string>',
    'conversation_id' => '<string>',
    'agent_id' => '<string>',
    'token' => '<string>',
    'image_ids' => '<string>',
    'user_metadata' => '<string>',
    'doc_mode' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://your-domain.com/api/dag"

	payload := strings.NewReader("{\n  \"q\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"token\": \"<string>\",\n  \"image_ids\": \"<string>\",\n  \"user_metadata\": \"<string>\",\n  \"doc_mode\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://your-domain.com/api/dag")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"q\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"token\": \"<string>\",\n  \"image_ids\": \"<string>\",\n  \"user_metadata\": \"<string>\",\n  \"doc_mode\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-domain.com/api/dag")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"q\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"token\": \"<string>\",\n  \"image_ids\": \"<string>\",\n  \"user_metadata\": \"<string>\",\n  \"doc_mode\": \"<string>\"\n}"

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

422

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

Authorizations

Authorization · string · header · required

API Key (fim_xxx) or JWT token

Body

application/json

Request body for ReAct/DAG streaming endpoints.

q · string · required

conversation_id · string | null

agent_id · string | null

token · string | null

image_ids · string | null

user_metadata · string | null

doc_mode · string | null

Response

200

application/json

Successful Response