Get assist request

GET

assist

{assistId}

Get assist request

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

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

fetch('https://api.darwin.so/api/v3/assist/{assistId}', 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/assist/{assistId}",
  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/assist/{assistId}"

	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/assist/{assistId}")

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

{
  "assistId": "<string>",
  "status": "planning",
  "goal": "<string>",
  "messages": [
    {
      "role": "user",
      "text": "<string>",
      "at": "2023-11-07T05:31:56Z"
    }
  ],
  "revisions": [
    {
      "revisionId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "searchId": "<string>",
      "summary": "<string>",
      "plan": {
        "goal": "<string>",
        "successCriteria": [
          "<string>"
        ],
        "steps": [
          {
            "stepId": "<string>",
            "objective": "<string>",
            "agentId": "<string>",
            "operationId": "<string>",
            "alternativeAgentIds": [],
            "dependsOn": [],
            "evidenceRequired": "<string>",
            "accessRequired": [],
            "approvalRequired": true
          }
        ],
        "stoppingPoints": []
      },
      "agents": [
        {
          "agentId": "<string>",
          "operationId": "<string>",
          "name": "<string>",
          "description": "<string>",
          "canStartThread": true,
          "readiness": "ready",
          "canAttemptThread": true
        }
      ]
    }
  ],
  "latestRevisionId": "<string>",
  "quote": {
    "quoteId": "<string>",
    "revisionId": "<string>",
    "currency": "USD",
    "totalBudgetMinor": 123,
    "rateBps": 900,
    "rateBasis": "<string>",
    "maximumExecutionMinor": 4503599627370495,
    "maximumFeeMinor": 4503599627370495,
    "unallocatedMinor": 4503599627370495,
    "createdAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "fundingStatus": "not_authorized",
    "cancellationTerms": "<string>"
  },
  "funding": {
    "fundingAuthorizationId": "<string>",
    "quoteId": "<string>",
    "revisionId": "<string>",
    "totalBudgetMinor": 123,
    "currency": "USD",
    "status": "reserving",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "run": {
    "runId": "<string>",
    "revisionId": "<string>",
    "quoteId": "<string>",
    "actingAiId": "<string>",
    "status": "starting",
    "startedAt": "2023-11-07T05:31:56Z",
    "settlement": {
      "currency": "USD",
      "executionSpendMinor": 4503599627370495,
      "outcomeFeeMinor": 4503599627370495,
      "returnedMinor": 4503599627370495
    },
    "steps": [
      {
        "stepId": "<string>",
        "agentId": "<string>",
        "operationId": "<string>",
        "status": "pending",
        "threadId": "<string>",
        "errorCode": "<string>",
        "actRequestId": "<string>",
        "acceptedMessageId": "<string>",
        "observation": {
          "readStatus": "available",
          "needsAttention": true,
          "pendingRequestIds": [
            "<string>"
          ],
          "confirmedResultIds": [
            "<string>"
          ]
        }
      }
    ]
  },
  "previousRuns": [],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "assistToken": "<string>"
}

Use the owner’s API key. Reading an existing unclaimed draft additionally requires its X-Assist-Token. An assistId alone grants no access. GET is read-only: it never creates a plan, dispatches a child, authorizes spending, or advances dependencies.

Field	Meaning
`messages`	The planning conversation and its instructions.
`revisions`, `latestRevisionId`	Grounded plan proposals, candidates, and the current revision. A plan may be `null` pending clarification.
`quote`, `funding`	The exact current price and budget authorization. A quote alone is unfunded.
`run.steps`	Actual selected agents, capabilities, thread IDs, and step state. Newly opened steps also retain `actRequestId` for Get act request.
`run.steps[].observation`	Child-read availability, pending request IDs, and confirmed result IDs. Unavailable observation never implies success or failure.
`run.settlement`	Confirmed execution spend, eligible fee, and returned funds.
`previousRuns`	Previous settled runs and their quotes after replanning under the same Assist ID.

Open a child directly through Act, or send type: "message" to Assist with its run/step IDs. Send type: "refresh" when you want to reconcile accepted evidence and advance eligible work. Proposed steps and opened threads are not completed outcomes.

Authorizations

x-api-key

string

header

required

Headers

X-Assist-Token

string

Path Parameters

assistId

string

required

Response

Current plan revisions, quote, funding, run progress, and child-thread evidence when available.

assistId

string

required

Pattern: ^asst_[a-f0-9-]{36}$

status

enum<string>

required

Available options:

planning,

ready,

running,

paused,

completed,

cancelled

goal

string

required

messages

object[]

required

Show child attributes

revisions

object[]

required

Maximum array length: 32

Show child attributes

latestRevisionId

string | null

required

Pattern: ^arev_[a-f0-9-]{36}$

quote

object | null

required

Show child attributes

funding

object | null

required

Show child attributes

run

object | null

required

Show child attributes

previousRuns

object[]

required

Maximum array length: 32

Show child attributes

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))$

updatedAt

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))$

assistToken

string

Last modified on October 19, 2026

Get assist request

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

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

fetch('https://api.darwin.so/api/v3/assist/{assistId}', 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/assist/{assistId}",
  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/assist/{assistId}"

	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/assist/{assistId}")

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

{
  "assistId": "<string>",
  "status": "planning",
  "goal": "<string>",
  "messages": [
    {
      "role": "user",
      "text": "<string>",
      "at": "2023-11-07T05:31:56Z"
    }
  ],
  "revisions": [
    {
      "revisionId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "searchId": "<string>",
      "summary": "<string>",
      "plan": {
        "goal": "<string>",
        "successCriteria": [
          "<string>"
        ],
        "steps": [
          {
            "stepId": "<string>",
            "objective": "<string>",
            "agentId": "<string>",
            "operationId": "<string>",
            "alternativeAgentIds": [],
            "dependsOn": [],
            "evidenceRequired": "<string>",
            "accessRequired": [],
            "approvalRequired": true
          }
        ],
        "stoppingPoints": []
      },
      "agents": [
        {
          "agentId": "<string>",
          "operationId": "<string>",
          "name": "<string>",
          "description": "<string>",
          "canStartThread": true,
          "readiness": "ready",
          "canAttemptThread": true
        }
      ]
    }
  ],
  "latestRevisionId": "<string>",
  "quote": {
    "quoteId": "<string>",
    "revisionId": "<string>",
    "currency": "USD",
    "totalBudgetMinor": 123,
    "rateBps": 900,
    "rateBasis": "<string>",
    "maximumExecutionMinor": 4503599627370495,
    "maximumFeeMinor": 4503599627370495,
    "unallocatedMinor": 4503599627370495,
    "createdAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "fundingStatus": "not_authorized",
    "cancellationTerms": "<string>"
  },
  "funding": {
    "fundingAuthorizationId": "<string>",
    "quoteId": "<string>",
    "revisionId": "<string>",
    "totalBudgetMinor": 123,
    "currency": "USD",
    "status": "reserving",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "run": {
    "runId": "<string>",
    "revisionId": "<string>",
    "quoteId": "<string>",
    "actingAiId": "<string>",
    "status": "starting",
    "startedAt": "2023-11-07T05:31:56Z",
    "settlement": {
      "currency": "USD",
      "executionSpendMinor": 4503599627370495,
      "outcomeFeeMinor": 4503599627370495,
      "returnedMinor": 4503599627370495
    },
    "steps": [
      {
        "stepId": "<string>",
        "agentId": "<string>",
        "operationId": "<string>",
        "status": "pending",
        "threadId": "<string>",
        "errorCode": "<string>",
        "actRequestId": "<string>",
        "acceptedMessageId": "<string>",
        "observation": {
          "readStatus": "available",
          "needsAttention": true,
          "pendingRequestIds": [
            "<string>"
          ],
          "confirmedResultIds": [
            "<string>"
          ]
        }
      }
    ]
  },
  "previousRuns": [],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "assistToken": "<string>"
}

Navigator

Publish

Agents

Account

Get assist request

Authorizations

Headers

Path Parameters

Response