.NET: [Feature Branch] Update HTTP API to be consistent across languages (#2118)

2026-06-16 21:04:09 +08:00 · 2025-11-12 08:55:53 -08:00
parent 586238c1c3
commit 2329bd4841
5 changed files with 283 additions and 51 deletions
@@ -35,8 +35,55 @@ Invoke-RestMethod -Method Post `
    -Body "Tell me a joke about a pirate."
 ```

-The response from the agent will be displayed in the terminal where you ran `func start`. The expected output will look something like:
+You can also send JSON requests:
+
+```bash
+curl -X POST http://localhost:7071/api/agents/Joker/run \
+    -H "Content-Type: application/json" \
+    -H "Accept: application/json" \
+    -d '{"message": "Tell me a joke about a pirate."}'
+```
+
+To continue a conversation, include the `thread_id` in the query string or JSON body:
+
+```bash
+curl -X POST "http://localhost:7071/api/agents/Joker/run?thread_id=@dafx-joker@your-thread-id" \
+    -H "Content-Type: application/json" \
+    -H "Accept: application/json" \
+    -d '{"message": "Tell me another one."}'
+```
+
+The response from the agent will be displayed in the terminal where you ran `func start`. The expected `text/plain` output will look something like:

 ```text
 Why don't pirates ever learn the alphabet? Because they always get stuck at "C"!
 ```
+
+The expected `application/json` output will look something like:
+
+```json
+{
+  "status": 200,
+  "thread_id": "@dafx-joker@your-thread-id",
+  "response": {
+    "Messages": [
+      {
+        "AuthorName": "Joker",
+        "CreatedAt": "2025-11-11T12:00:00.0000000Z",
+        "Role": "assistant",
+        "Contents": [
+          {
+            "Type": "text",
+            "Text": "Why don't pirates ever learn the alphabet? Because they always get stuck at 'C'!"
+          }
+        ]
+      }
+    ],
+    "Usage": {
+      "InputTokenCount": 78,
+      "OutputTokenCount": 36,
+      "TotalTokenCount": 114
+    }
+  }
+}
+```
@@ -29,7 +29,7 @@ curl -i -X POST http://localhost:7071/api/agents/publisher/run \
    -d 'Start a content generation workflow for the topic \"The Future of Artificial Intelligence\"'

 # Save the thread ID to a variable and print it to the terminal
-threadId=$(cat headers.txt | grep "X-Agent-Thread" | cut -d' ' -f2)
+threadId=$(cat headers.txt | grep "x-ms-thread-id" | cut -d' ' -f2)
 echo "Thread ID: $threadId"
 ```

@@ -43,7 +43,7 @@ Invoke-RestMethod -Method Post `
    -Body 'Start a content generation workflow for the topic \"The Future of Artificial Intelligence\"' `

 # Save the thread ID to a variable and print it to the console
-$threadId = $ResponseHeaders['X-Agent-Thread']
+$threadId = $ResponseHeaders['x-ms-thread-id']
 Write-Host "Thread ID: $threadId"
 ```

@@ -52,12 +52,12 @@ The response will be a text string that looks something like the following, indi
 ```http
 HTTP/1.1 200 OK
 Content-Type: text/plain
-X-Agent-Thread: @publisher@351ec855-7f4d-4527-a60d-498301ced36d
+x-ms-thread-id: @publisher@351ec855-7f4d-4527-a60d-498301ced36d

 ```

 The `x-ms-thread-id` response header contains the thread ID, which can be used to continue the conversation by passing it as a query parameter (`thread_id`) to the `run` endpoint. The commands above show how to save the thread ID to a `$threadId` variable for use in subsequent requests.
-
+
 Behind the scenes, the publisher agent will:

 1. Start the content generation workflow via a tool call
@@ -70,12 +70,12 @@ Bash (Linux/macOS/WSL):
 ```bash
 # Approve the content
 curl -X POST "http://localhost:7071/api/agents/publisher/run?thread_id=$threadId" \
-    -H "Content-Type: text/plain" \
+    -H "Content-Type: text/plain" \
    -d 'Approve the content'

 # Reject the content with feedback
 curl -X POST "http://localhost:7071/api/agents/publisher/run?thread_id=$threadId" \
-    -H "Content-Type: text/plain" \
+    -H "Content-Type: text/plain" \
    -d 'Reject the content with feedback: The article needs more technical depth and better examples.'
 ```

@@ -85,13 +85,13 @@ PowerShell:
 # Approve the content
 Invoke-RestMethod -Method Post `
    -Uri "http://localhost:7071/api/agents/publisher/run?thread_id=$threadId" `
-    -ContentType text/plain `
+    -ContentType text/plain `
    -Body 'Approve the content'

 # Reject the content with feedback
 Invoke-RestMethod -Method Post `
    -Uri "http://localhost:7071/api/agents/publisher/run?thread_id=$threadId" `
-    -ContentType text/plain `
+    -ContentType text/plain `
    -Body 'Reject the content with feedback: The article needs more technical depth and better examples.'
 ```

@@ -101,7 +101,7 @@ Once the workflow has completed, you can get the status by prompting the publish

 ```bash
 curl -X POST "http://localhost:7071/api/agents/publisher/run?thread_id=$threadId" \
-    -H "Content-Type: text/plain" \
+    -H "Content-Type: text/plain" \
    -d 'Get the status of the workflow you previously started'
 ```

@@ -110,7 +110,7 @@ PowerShell:
 ```powershell
 Invoke-RestMethod -Method Post `
    -Uri "http://localhost:7071/api/agents/publisher/run?thread_id=$threadId" `
-    -ContentType text/plain `
+    -ContentType text/plain `
    -Body 'Get the status of the workflow you previously started'
 ```

@@ -9,19 +9,19 @@ Start a content generation workflow for the topic 'The Future of Artificial Inte
@threadId = <YOUR_THREAD_ID>

 ### Check the status of the workflow
-POST http://localhost:7071/api/agents/publisher/run?threadId={{threadId}}
+POST http://localhost:7071/api/agents/publisher/run?thread_id={{threadId}}
 Content-Type: text/plain

 Check the status of the workflow you previously started

 ### Reject content with feedback
-POST http://localhost:7071/api/agents/publisher/run?threadId={{threadId}}
+POST http://localhost:7071/api/agents/publisher/run?thread_id={{threadId}}
 Content-Type: text/plain

 Reject the content with feedback: The article needs more technical depth and better examples.

 ### Approve content
-POST http://localhost:7071/api/agents/publisher/run?threadId={{threadId}}
+POST http://localhost:7071/api/agents/publisher/run?thread_id={{threadId}}
 Content-Type: text/plain

 Approve the content