Open the organization assistant

curl --request POST \
  --url https://api.recursion.labelbox.com/managed-agents/v1/assistant \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "<string>",
  "reset": false
}
'

import requests

url = "https://api.recursion.labelbox.com/managed-agents/v1/assistant"

payload = {
    "question": "<string>",
    "reset": False
}
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({question: '<string>', reset: false})
};

fetch('https://api.recursion.labelbox.com/managed-agents/v1/assistant', 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/assistant",
  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([
    'question' => '<string>',
    'reset' => false
  ]),
  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/assistant"

	payload := strings.NewReader("{\n  \"question\": \"<string>\",\n  \"reset\": false\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/assistant")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"question\": \"<string>\",\n  \"reset\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.recursion.labelbox.com/managed-agents/v1/assistant")

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  \"question\": \"<string>\",\n  \"reset\": false\n}"

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

{
  "created": true,
  "session": {
    "computer_use": true,
    "config": {},
    "created_at": "2023-11-07T05:31:56Z",
    "credential_refs": [
      {
        "credential_id": "<string>",
        "vault_id": "<string>"
      }
    ],
    "credential_refs_configured": true,
    "kind": "api_call",
    "organization_id": "<string>",
    "root_session_id": "<string>",
    "session_id": "<string>",
    "session_path": "<string>",
    "status": "active",
    "updated_at": "2023-11-07T05:31:56Z",
    "access_policy": "platform_internal",
    "active_handoff": {
      "deadline_at": "2023-11-07T05:31:56Z",
      "handoff_id": "<string>",
      "reason": "<string>",
      "requested_at": "2023-11-07T05:31:56Z",
      "state": "awaiting_user",
      "access_expires_at": "2023-11-07T05:31:56Z",
      "wake_cause": "<string>"
    },
    "agent_id": "<string>",
    "agent_snapshot": {},
    "agent_version_id": "<string>",
    "concurrency_slot_held": true,
    "costState": "final",
    "costUsd": "1.234567",
    "effective_model": "<string>",
    "environment_id": "<string>",
    "execution_state": "provisioning",
    "external_source_id": "<string>",
    "external_source_type": "<string>",
    "failure": {
      "at": "2023-11-07T05:31:56Z",
      "category": "transient",
      "code": "<string>",
      "message": "<string>",
      "phase": "<string>",
      "retryable": true
    },
    "forked_at_event_id": "<string>",
    "last_activity_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "model_ref_id": "<string>",
    "model_snapshot": {},
    "parent_session_id": "<string>",
    "sandbox_instance_id": "<string>",
    "sandbox_provider": "<string>",
    "source_refs": {},
    "stop_reason": "<string>",
    "user_id": "<string>",
    "vault_ids": [
      "<string>"
    ],
    "wake_at": "2023-11-07T05:31:56Z"
  }
}

{
  "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": "content_store_unconfigured",
  "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

Open the organization assistant

Returns the caller's organization assistant, starting one if they have none (created is true when this call started it): an assistant session that knows the platform's capabilities and the organization's agents, environments, skills and connections, and helps design, set up and check agents. It changes nothing by itself: it asks typed questions, presents solution blueprints and proposes plans, and only a plan the caller approves with managedAgentsSubmitAssistantInteractionDecision is executed, under the caller's own permissions. Talk to it with managedAgentsSendSessionEvents and read its events. One assistant per caller; {"reset": true} ends it. Calls not made on behalf of a person get 403.

POST

managed-agents

assistant

curl --request POST \
  --url https://api.recursion.labelbox.com/managed-agents/v1/assistant \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "<string>",
  "reset": false
}
'

import requests

url = "https://api.recursion.labelbox.com/managed-agents/v1/assistant"

payload = {
    "question": "<string>",
    "reset": False
}
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({question: '<string>', reset: false})
};

fetch('https://api.recursion.labelbox.com/managed-agents/v1/assistant', 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/assistant",
  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([
    'question' => '<string>',
    'reset' => false
  ]),
  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/assistant"

	payload := strings.NewReader("{\n  \"question\": \"<string>\",\n  \"reset\": false\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/assistant")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"question\": \"<string>\",\n  \"reset\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.recursion.labelbox.com/managed-agents/v1/assistant")

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  \"question\": \"<string>\",\n  \"reset\": false\n}"

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

{
  "created": true,
  "session": {
    "computer_use": true,
    "config": {},
    "created_at": "2023-11-07T05:31:56Z",
    "credential_refs": [
      {
        "credential_id": "<string>",
        "vault_id": "<string>"
      }
    ],
    "credential_refs_configured": true,
    "kind": "api_call",
    "organization_id": "<string>",
    "root_session_id": "<string>",
    "session_id": "<string>",
    "session_path": "<string>",
    "status": "active",
    "updated_at": "2023-11-07T05:31:56Z",
    "access_policy": "platform_internal",
    "active_handoff": {
      "deadline_at": "2023-11-07T05:31:56Z",
      "handoff_id": "<string>",
      "reason": "<string>",
      "requested_at": "2023-11-07T05:31:56Z",
      "state": "awaiting_user",
      "access_expires_at": "2023-11-07T05:31:56Z",
      "wake_cause": "<string>"
    },
    "agent_id": "<string>",
    "agent_snapshot": {},
    "agent_version_id": "<string>",
    "concurrency_slot_held": true,
    "costState": "final",
    "costUsd": "1.234567",
    "effective_model": "<string>",
    "environment_id": "<string>",
    "execution_state": "provisioning",
    "external_source_id": "<string>",
    "external_source_type": "<string>",
    "failure": {
      "at": "2023-11-07T05:31:56Z",
      "category": "transient",
      "code": "<string>",
      "message": "<string>",
      "phase": "<string>",
      "retryable": true
    },
    "forked_at_event_id": "<string>",
    "last_activity_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "model_ref_id": "<string>",
    "model_snapshot": {},
    "parent_session_id": "<string>",
    "sandbox_instance_id": "<string>",
    "sandbox_provider": "<string>",
    "source_refs": {},
    "stop_reason": "<string>",
    "user_id": "<string>",
    "vault_ids": [
      "<string>"
    ],
    "wake_at": "2023-11-07T05:31:56Z"
  }
}

{
  "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": "content_store_unconfigured",
  "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

Body

application/json

Open the organization assistant, ask a question, or prepare a deterministic template plan for approval.

question

string

Ask a conversational question; mutually exclusive with template.

reset

boolean

default:false

End the previous conversation before opening this one.

template

object

Prepare this catalog template for approval without a model planning turn. Starts a new conversation.

Show child attributes

Response

Response body of managedAgentsOpenSessionAnalyst: the caller's read-only analyst session over a session tree, if there is one, and whether it was just started.

created

boolean

required

True when this call started the analyst; false when it returned the caller's existing conversation with this tree, or none.

session

object

The analyst session, when the caller has a conversation with this tree. Send questions to it with managedAgentsSendSessionEvents and read answers from its events; its kind is session_analyst and its access policy platform_internal. Absent when nothing has been asked yet, or the conversation was just reset: a question starts one.

Show child attributes

API reference

Endpoints

Open the organization assistant

Authorizations

Headers

Body

Response