Get act request

GET

act

requests

{actRequestId}

Get act request

curl --request GET \
  --url https://api.darwin.so/api/v3/act/requests/{actRequestId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.darwin.so/api/v3/act/requests/{actRequestId}', 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.darwin.so/api/v3/act/requests/{actRequestId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.darwin.so/api/v3/act/requests/{actRequestId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.darwin.so/api/v3/act/requests/{actRequestId}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "type": "request",
  "actRequestId": "<string>",
  "searchId": "<string>",
  "status": "pending",
  "createdAt": "2023-11-07T05:31:56Z",
  "threads": [
    {
      "agentId": "<string>",
      "operationId": "<string>",
      "operationRevision": 123,
      "threadId": "<string>",
      "messageId": "<string>",
      "errorCode": "<string>",
      "state": {
        "thread": "<string>",
        "messages": [
          {
            "message": "<string>",
            "from": "you",
            "content": [
              {
                "type": "text",
                "text": "<string>"
              }
            ],
            "status": "accepted",
            "createdAt": "2023-11-07T05:31:56Z",
            "type": "input_response",
            "request": "<string>",
            "arguments": {}
          }
        ],
        "actions": [
          {
            "action": "<string>",
            "capability": "<string>",
            "request": "<string>",
            "status": "awaiting_confirmation",
            "cancellationRequested": true,
            "accepted": true
          }
        ],
        "requests": [
          {
            "request": "<string>",
            "action": "<string>",
            "status": "pending",
            "type": "input_request",
            "capability": "<string>",
            "inputSchema": {},
            "expiresAt": "2023-11-07T05:31:56Z",
            "inputSchemaResources": {}
          }
        ],
        "cursor": "<string>",
        "hasMore": true,
        "archived": true,
        "needsAttention": true,
        "errors": [
          {
            "event": "<string>",
            "code": "<string>",
            "retryable": true,
            "createdAt": "2023-11-07T05:31:56Z",
            "action": "<string>"
          }
        ]
      }
    }
  ],
  "threadId": "<string>"
}

Use the actRequestId returned by Act, or an Assist child’s actRequestId. Current thread state is included by default in threads[].state. Keep the child’s threadId for all replies through the same Act endpoint.

The default inclusion of thread state is pending deployment with the six-endpoint Navigator contract. Until then, send includeThreadState=true explicitly.

curl 'https://api.darwin.so/api/v3/act/requests/ACT_REQUEST_ID?includeThreadState=true' \
  -H "x-api-key: $DARWIN_API_KEY"

Each state contains messages, actions, requests, cursor, and hasMore. Read the next page with the same Act request ID, that child’s threadId, and its cursor. limit is 1–100, default 20 per thread. Every child is checked against current authority; a thread from another request is rejected. Copy authentication, payment, action, and approval request IDs from that child’s state.requests. A completed request receipt means thread creation finished; inspect the actual thread for evidence of delivered work. Failed starts have no thread state. GET does not start work or record consent. Set includeThreadState=false only when you want the original receipt without child state. Existing thread-read URLs remain compatibility routes for clients that already use them.

Authorizations

x-api-key

string

header

required

Path Parameters

actRequestId

string

required

Query Parameters

includeThreadState

boolean

default:true

Include authorized child thread messages, actions and pending requests.

threadId

string

Read state for this child thread only. Must belong to the Act request.

cursor

string

Read the next message page for threadId. Requires includeThreadState=true.

limit

integer

default:20

Required range: 1 <= x <= 100

Response

Act request receipt and optional live, authorized child thread state.

type

string

required

Allowed value: "request"

actRequestId

string

required

Required string length: 1 - 200

Pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$

searchId

string | null

required

Required string length: 1 - 200

Pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$

status

enum<string>

required

Act Request handoff status only. Completed means thread receipts were created; read each thread for action confirmation and provider result.

Available options:

pending,

completed,

partial,

failed

createdAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

threads

object[]

required

Required array length: 1 - 8 elements

Show child attributes

threadId

string

The one created thread. Omitted for historical failed or batch receipts.

Required string length: 1 - 200

Pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$

Last modified on October 19, 2026

Get act request

curl --request GET \
  --url https://api.darwin.so/api/v3/act/requests/{actRequestId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.darwin.so/api/v3/act/requests/{actRequestId}', 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.darwin.so/api/v3/act/requests/{actRequestId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.darwin.so/api/v3/act/requests/{actRequestId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.darwin.so/api/v3/act/requests/{actRequestId}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "type": "request",
  "actRequestId": "<string>",
  "searchId": "<string>",
  "status": "pending",
  "createdAt": "2023-11-07T05:31:56Z",
  "threads": [
    {
      "agentId": "<string>",
      "operationId": "<string>",
      "operationRevision": 123,
      "threadId": "<string>",
      "messageId": "<string>",
      "errorCode": "<string>",
      "state": {
        "thread": "<string>",
        "messages": [
          {
            "message": "<string>",
            "from": "you",
            "content": [
              {
                "type": "text",
                "text": "<string>"
              }
            ],
            "status": "accepted",
            "createdAt": "2023-11-07T05:31:56Z",
            "type": "input_response",
            "request": "<string>",
            "arguments": {}
          }
        ],
        "actions": [
          {
            "action": "<string>",
            "capability": "<string>",
            "request": "<string>",
            "status": "awaiting_confirmation",
            "cancellationRequested": true,
            "accepted": true
          }
        ],
        "requests": [
          {
            "request": "<string>",
            "action": "<string>",
            "status": "pending",
            "type": "input_request",
            "capability": "<string>",
            "inputSchema": {},
            "expiresAt": "2023-11-07T05:31:56Z",
            "inputSchemaResources": {}
          }
        ],
        "cursor": "<string>",
        "hasMore": true,
        "archived": true,
        "needsAttention": true,
        "errors": [
          {
            "event": "<string>",
            "code": "<string>",
            "retryable": true,
            "createdAt": "2023-11-07T05:31:56Z",
            "action": "<string>"
          }
        ]
      }
    }
  ],
  "threadId": "<string>"
}

Navigator

Agents

Account

Get act request

Authorizations

Path Parameters

Query Parameters

Response