Decide on an assistant interaction

curl --request POST \
  --url https://api.recursion.labelbox.com/managed-agents/v1/sessions/{sessionId}/interactions/{interactionId}/decide \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "digest": "<string>",
  "revision": 4503599627370496,
  "answers": [
    {
      "questionId": "<string>",
      "optionIds": [
        "<string>"
      ],
      "text": "<string>"
    }
  ],
  "comments": [
    {
      "text": "<string>",
      "field": "<string>",
      "stepId": "<string>"
    }
  ],
  "disabledSteps": [
    "<string>"
  ],
  "edits": {},
  "note": "<string>"
}
'

import requests

url = "https://api.recursion.labelbox.com/managed-agents/v1/sessions/{sessionId}/interactions/{interactionId}/decide"

payload = {
    "digest": "<string>",
    "revision": 4503599627370496,
    "answers": [
        {
            "questionId": "<string>",
            "optionIds": ["<string>"],
            "text": "<string>"
        }
    ],
    "comments": [
        {
            "text": "<string>",
            "field": "<string>",
            "stepId": "<string>"
        }
    ],
    "disabledSteps": ["<string>"],
    "edits": {},
    "note": "<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({
    digest: '<string>',
    revision: 4503599627370496,
    answers: [{questionId: '<string>', optionIds: ['<string>'], text: '<string>'}],
    comments: [{text: '<string>', field: '<string>', stepId: '<string>'}],
    disabledSteps: ['<string>'],
    edits: {},
    note: '<string>'
  })
};

fetch('https://api.recursion.labelbox.com/managed-agents/v1/sessions/{sessionId}/interactions/{interactionId}/decide', 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.recursion.labelbox.com/managed-agents/v1/sessions/{sessionId}/interactions/{interactionId}/decide",
  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([
    'digest' => '<string>',
    'revision' => 4503599627370496,
    'answers' => [
        [
                'questionId' => '<string>',
                'optionIds' => [
                                '<string>'
                ],
                'text' => '<string>'
        ]
    ],
    'comments' => [
        [
                'text' => '<string>',
                'field' => '<string>',
                'stepId' => '<string>'
        ]
    ],
    'disabledSteps' => [
        '<string>'
    ],
    'edits' => [
        
    ],
    'note' => '<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://api.recursion.labelbox.com/managed-agents/v1/sessions/{sessionId}/interactions/{interactionId}/decide"

	payload := strings.NewReader("{\n  \"digest\": \"<string>\",\n  \"revision\": 4503599627370496,\n  \"answers\": [\n    {\n      \"questionId\": \"<string>\",\n      \"optionIds\": [\n        \"<string>\"\n      ],\n      \"text\": \"<string>\"\n    }\n  ],\n  \"comments\": [\n    {\n      \"text\": \"<string>\",\n      \"field\": \"<string>\",\n      \"stepId\": \"<string>\"\n    }\n  ],\n  \"disabledSteps\": [\n    \"<string>\"\n  ],\n  \"edits\": {},\n  \"note\": \"<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://api.recursion.labelbox.com/managed-agents/v1/sessions/{sessionId}/interactions/{interactionId}/decide")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"digest\": \"<string>\",\n  \"revision\": 4503599627370496,\n  \"answers\": [\n    {\n      \"questionId\": \"<string>\",\n      \"optionIds\": [\n        \"<string>\"\n      ],\n      \"text\": \"<string>\"\n    }\n  ],\n  \"comments\": [\n    {\n      \"text\": \"<string>\",\n      \"field\": \"<string>\",\n      \"stepId\": \"<string>\"\n    }\n  ],\n  \"disabledSteps\": [\n    \"<string>\"\n  ],\n  \"edits\": {},\n  \"note\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.recursion.labelbox.com/managed-agents/v1/sessions/{sessionId}/interactions/{interactionId}/decide")

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  \"digest\": \"<string>\",\n  \"revision\": 4503599627370496,\n  \"answers\": [\n    {\n      \"questionId\": \"<string>\",\n      \"optionIds\": [\n        \"<string>\"\n      ],\n      \"text\": \"<string>\"\n    }\n  ],\n  \"comments\": [\n    {\n      \"text\": \"<string>\",\n      \"field\": \"<string>\",\n      \"stepId\": \"<string>\"\n    }\n  ],\n  \"disabledSteps\": [\n    \"<string>\"\n  ],\n  \"edits\": {},\n  \"note\": \"<string>\"\n}"

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

{
  "digest": "<string>",
  "interactionId": "<string>",
  "kind": "question",
  "origin": "assistant",
  "requestedAt": "2023-11-07T05:31:56Z",
  "revision": 4503599627370496,
  "status": "pending",
  "title": "<string>",
  "blueprint": {
    "agents": [
      {
        "role": "<string>",
        "model": "<string>",
        "responsibilities": "<string>"
      }
    ],
    "capabilities": [
      {
        "capabilityId": "<string>",
        "kind": "<string>",
        "name": "<string>",
        "status": "<string>",
        "purpose": "<string>"
      }
    ],
    "trigger": {
      "kind": "manual",
      "detail": "<string>"
    },
    "checkpoints": [
      "<string>"
    ],
    "costClass": "low",
    "environment": "<string>",
    "gaps": [
      "<string>"
    ],
    "outputs": [
      "<string>"
    ]
  },
  "decision": {
    "decidedAt": "2023-11-07T05:31:56Z",
    "decision": "answered",
    "answers": [
      {
        "questionId": "<string>",
        "optionIds": [
          "<string>"
        ],
        "text": "<string>"
      }
    ],
    "comments": [
      {
        "text": "<string>",
        "field": "<string>",
        "stepId": "<string>"
      }
    ],
    "decidedBy": "<string>",
    "note": "<string>"
  },
  "plan": {
    "steps": [
      {
        "action": "<string>",
        "costClass": "none",
        "enabled": true,
        "input": {},
        "stepId": "<string>",
        "title": "<string>",
        "dependsOn": [
          "<string>"
        ],
        "fields": [
          {
            "label": "<string>",
            "name": "<string>",
            "widget": "text",
            "help": "<string>",
            "options": [
              {
                "label": "<string>",
                "optionId": "<string>",
                "description": "<string>"
              }
            ],
            "required": true
          }
        ],
        "optional": true,
        "warnings": [
          "<string>"
        ]
      }
    ],
    "prerequisites": [
      {
        "kind": "connect_integration",
        "label": "<string>",
        "prerequisiteId": "<string>",
        "satisfied": true,
        "capabilityId": "<string>",
        "detail": "<string>",
        "link": "<string>"
      }
    ]
  },
  "questions": [
    {
      "input": "single_select",
      "prompt": "<string>",
      "questionId": "<string>",
      "allowOther": true,
      "multiple": true,
      "optional": true,
      "options": [
        {
          "label": "<string>",
          "optionId": "<string>",
          "description": "<string>"
        }
      ],
      "picker": "agent"
    }
  ],
  "stepResults": [
    {
      "status": "running",
      "stepId": "<string>",
      "link": "<string>",
      "message": "<string>",
      "resourceId": "<string>",
      "resourceKind": "<string>"
    }
  ],
  "summary": "<string>"
}

{
  "code": "invalid_json",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unauthorized",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "forbidden",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "not_found",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "conflict",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "payload_too_large",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unsupported_media_type",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "rate_limit_exceeded",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "internal_error",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "bad_gateway",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "assistant_decisions_unavailable",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "gateway_timeout",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

Sessions

Decide on an assistant interaction

Records the caller’s decision on the pending interaction an assistant put in front of them — answers to its questions, acceptance of a blueprint, approval of a plan, a revision request, or dismissal — and delivers it to the assistant as the caller’s next message. Only the person who opened the assistant may decide, and only on the exact revision and digest they were shown (409 otherwise). Approving a plan requires a signed-in user holding every permission its enabled steps need; the plan then runs in the background, one existing operation per step, under the caller’s permissions, and its progress is appended to the assistant’s events. The response is the interaction after the decision.

POST

managed-agents

sessions

{sessionId}

interactions

{interactionId}

decide

Decide on an assistant interaction

curl --request POST \
  --url https://api.recursion.labelbox.com/managed-agents/v1/sessions/{sessionId}/interactions/{interactionId}/decide \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "digest": "<string>",
  "revision": 4503599627370496,
  "answers": [
    {
      "questionId": "<string>",
      "optionIds": [
        "<string>"
      ],
      "text": "<string>"
    }
  ],
  "comments": [
    {
      "text": "<string>",
      "field": "<string>",
      "stepId": "<string>"
    }
  ],
  "disabledSteps": [
    "<string>"
  ],
  "edits": {},
  "note": "<string>"
}
'

import requests

url = "https://api.recursion.labelbox.com/managed-agents/v1/sessions/{sessionId}/interactions/{interactionId}/decide"

payload = {
    "digest": "<string>",
    "revision": 4503599627370496,
    "answers": [
        {
            "questionId": "<string>",
            "optionIds": ["<string>"],
            "text": "<string>"
        }
    ],
    "comments": [
        {
            "text": "<string>",
            "field": "<string>",
            "stepId": "<string>"
        }
    ],
    "disabledSteps": ["<string>"],
    "edits": {},
    "note": "<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({
    digest: '<string>',
    revision: 4503599627370496,
    answers: [{questionId: '<string>', optionIds: ['<string>'], text: '<string>'}],
    comments: [{text: '<string>', field: '<string>', stepId: '<string>'}],
    disabledSteps: ['<string>'],
    edits: {},
    note: '<string>'
  })
};

fetch('https://api.recursion.labelbox.com/managed-agents/v1/sessions/{sessionId}/interactions/{interactionId}/decide', 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.recursion.labelbox.com/managed-agents/v1/sessions/{sessionId}/interactions/{interactionId}/decide",
  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([
    'digest' => '<string>',
    'revision' => 4503599627370496,
    'answers' => [
        [
                'questionId' => '<string>',
                'optionIds' => [
                                '<string>'
                ],
                'text' => '<string>'
        ]
    ],
    'comments' => [
        [
                'text' => '<string>',
                'field' => '<string>',
                'stepId' => '<string>'
        ]
    ],
    'disabledSteps' => [
        '<string>'
    ],
    'edits' => [
        
    ],
    'note' => '<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://api.recursion.labelbox.com/managed-agents/v1/sessions/{sessionId}/interactions/{interactionId}/decide"

	payload := strings.NewReader("{\n  \"digest\": \"<string>\",\n  \"revision\": 4503599627370496,\n  \"answers\": [\n    {\n      \"questionId\": \"<string>\",\n      \"optionIds\": [\n        \"<string>\"\n      ],\n      \"text\": \"<string>\"\n    }\n  ],\n  \"comments\": [\n    {\n      \"text\": \"<string>\",\n      \"field\": \"<string>\",\n      \"stepId\": \"<string>\"\n    }\n  ],\n  \"disabledSteps\": [\n    \"<string>\"\n  ],\n  \"edits\": {},\n  \"note\": \"<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://api.recursion.labelbox.com/managed-agents/v1/sessions/{sessionId}/interactions/{interactionId}/decide")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"digest\": \"<string>\",\n  \"revision\": 4503599627370496,\n  \"answers\": [\n    {\n      \"questionId\": \"<string>\",\n      \"optionIds\": [\n        \"<string>\"\n      ],\n      \"text\": \"<string>\"\n    }\n  ],\n  \"comments\": [\n    {\n      \"text\": \"<string>\",\n      \"field\": \"<string>\",\n      \"stepId\": \"<string>\"\n    }\n  ],\n  \"disabledSteps\": [\n    \"<string>\"\n  ],\n  \"edits\": {},\n  \"note\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.recursion.labelbox.com/managed-agents/v1/sessions/{sessionId}/interactions/{interactionId}/decide")

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  \"digest\": \"<string>\",\n  \"revision\": 4503599627370496,\n  \"answers\": [\n    {\n      \"questionId\": \"<string>\",\n      \"optionIds\": [\n        \"<string>\"\n      ],\n      \"text\": \"<string>\"\n    }\n  ],\n  \"comments\": [\n    {\n      \"text\": \"<string>\",\n      \"field\": \"<string>\",\n      \"stepId\": \"<string>\"\n    }\n  ],\n  \"disabledSteps\": [\n    \"<string>\"\n  ],\n  \"edits\": {},\n  \"note\": \"<string>\"\n}"

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

{
  "digest": "<string>",
  "interactionId": "<string>",
  "kind": "question",
  "origin": "assistant",
  "requestedAt": "2023-11-07T05:31:56Z",
  "revision": 4503599627370496,
  "status": "pending",
  "title": "<string>",
  "blueprint": {
    "agents": [
      {
        "role": "<string>",
        "model": "<string>",
        "responsibilities": "<string>"
      }
    ],
    "capabilities": [
      {
        "capabilityId": "<string>",
        "kind": "<string>",
        "name": "<string>",
        "status": "<string>",
        "purpose": "<string>"
      }
    ],
    "trigger": {
      "kind": "manual",
      "detail": "<string>"
    },
    "checkpoints": [
      "<string>"
    ],
    "costClass": "low",
    "environment": "<string>",
    "gaps": [
      "<string>"
    ],
    "outputs": [
      "<string>"
    ]
  },
  "decision": {
    "decidedAt": "2023-11-07T05:31:56Z",
    "decision": "answered",
    "answers": [
      {
        "questionId": "<string>",
        "optionIds": [
          "<string>"
        ],
        "text": "<string>"
      }
    ],
    "comments": [
      {
        "text": "<string>",
        "field": "<string>",
        "stepId": "<string>"
      }
    ],
    "decidedBy": "<string>",
    "note": "<string>"
  },
  "plan": {
    "steps": [
      {
        "action": "<string>",
        "costClass": "none",
        "enabled": true,
        "input": {},
        "stepId": "<string>",
        "title": "<string>",
        "dependsOn": [
          "<string>"
        ],
        "fields": [
          {
            "label": "<string>",
            "name": "<string>",
            "widget": "text",
            "help": "<string>",
            "options": [
              {
                "label": "<string>",
                "optionId": "<string>",
                "description": "<string>"
              }
            ],
            "required": true
          }
        ],
        "optional": true,
        "warnings": [
          "<string>"
        ]
      }
    ],
    "prerequisites": [
      {
        "kind": "connect_integration",
        "label": "<string>",
        "prerequisiteId": "<string>",
        "satisfied": true,
        "capabilityId": "<string>",
        "detail": "<string>",
        "link": "<string>"
      }
    ]
  },
  "questions": [
    {
      "input": "single_select",
      "prompt": "<string>",
      "questionId": "<string>",
      "allowOther": true,
      "multiple": true,
      "optional": true,
      "options": [
        {
          "label": "<string>",
          "optionId": "<string>",
          "description": "<string>"
        }
      ],
      "picker": "agent"
    }
  ],
  "stepResults": [
    {
      "status": "running",
      "stepId": "<string>",
      "link": "<string>",
      "message": "<string>",
      "resourceId": "<string>",
      "resourceKind": "<string>"
    }
  ],
  "summary": "<string>"
}

{
  "code": "invalid_json",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unauthorized",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "forbidden",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "not_found",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "conflict",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "payload_too_large",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unsupported_media_type",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "rate_limit_exceeded",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "internal_error",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "bad_gateway",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "assistant_decisions_unavailable",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "gateway_timeout",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

Authorizations

Authorization

string

header

required

A Recursion API key, created in the console under API keys.

Headers

x-tenant-id

string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1

x-organization-id

string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Path Parameters

sessionId

string<uuid>

required

The assistant session (UUID) that made the interaction.

interactionId

string

required

The interaction id, from the interaction's event.

Maximum string length: 128

Body

application/json

Request body of managedAgentsSubmitAssistantInteractionDecision: one decision on the exact revision of an assistant interaction the caller was shown.

decision

enum<string>

required

The decision: answer a question interaction, accept a blueprint, approve a plan, ask for a revision of a blueprint or plan, or dismiss any pending interaction.

Available options:

answer,

accept,

approve,

request_revision,

cancel

digest

string

required

The digest of that revision, as shown. A mismatch is a 409.

Maximum string length: 128

revision

integer

required

The interaction revision being decided, as shown. A stale revision is a 409.

Required range: 1 <= x <= 9007199254740991

answers

object[]

Answers, with decision answer. Every non-optional question needs one.

Maximum array length: 4

Show child attributes

comments

object[]

Comments pinned to steps or fields, with decision request_revision.

Maximum array length: 30

Show child attributes

disabledSteps

string[]

With decision approve: optional steps to turn off.

Maximum array length: 12

edits

object

With decision approve: replacement values for editable step fields, keyed by stepId and then field name. Any edit records a new revision written by the person.

Show child attributes

note

string

A note for the assistant. Required for request_revision unless comments are given.

Maximum string length: 4000

Response

A typed request for the reader's input that an assistant put in front of them: questions, a solution blueprint, or a plan of changes. Each state is recorded as one event; the latest event per interactionId is the current state.

digest

string

required

Digest of this revision's content. A decision names it so a person decides exactly what they were shown.

interactionId

string

required

Stable id of the interaction. Revisions of a blueprint or plan keep it.

kind

enum<string>

required

What is being asked: questions, a solution blueprint, or a plan of changes.

Available options:

question,

blueprint,

plan

origin

enum<string>

required

Who wrote this revision: the assistant, or the person through an inline edit.

Available options:

assistant,

user

requestedAt

string<date-time>

required

When this revision was put in front of the reader.

revision

integer

required

Revision number, starting at 1. Only the latest revision of a pending interaction can be decided.

Required range: 1 <= x <= 9007199254740991

status

enum<string>

required

Lifecycle state of the interaction.

Available options:

pending,

answered,

accepted,

revision_requested,

cancelled,

superseded,

executing,

completed,

failed

title

string

required

Short heading for the interaction.

blueprint

object

The solution design, on a blueprint interaction.

Show child attributes

decision

object

The person's decision, once one was made.

Show child attributes

plan

object

The changes, on a plan interaction.

Show child attributes

questions

object[]

The questions, on a question interaction.

Show child attributes

stepResults

object[]

What each approved step did, once a plan executes.

Show child attributes

summary

string

One or two sentences on why this is being asked.

API reference

Endpoints

Decide on an assistant interaction

Authorizations

Headers

Path Parameters

Body

Response