Get agent by name

Fetch an agent by its (org_id, name) handle.

Mirrors :meth:Action.from_name: name + owning org are jointly unique (enforced by the agents_unique_org_name constraint from chats_018), so a name plus the resource-owner org always addresses at most one agent. The dedicated /name/ subpath avoids collision with /agents/<agent_id> for agent ids that happen to look like names. Unlike :func:get_agent (which derives the org from the looked-up record), name lookup needs the org up-front, so it goes through the X-Roboto-Resource-Owner-Id header via REQUIRES_OWNER_ORG.

Agent names are free text, so the path segment arrives percent-encoded and has to be decoded before it can match a stored name. API Gateway hands the proxy path through verbatim – without this, an agent named “Food Preference User Triage” is looked up as Food%20Preference%20User%20Triage and always 404s.

Access control

requires_resource_owner
Restricted tokens need the API scope api.everything_else

GET/v1/ai/agents/name/{name}

Authorization

AuthorizationBearer token · headerrequired

Path parameters

namestringrequired

Header parameters

X-Roboto-Org-Idstring

X-Roboto-User-Idstring

Responses

200

dataobjectrequired

A pre-filled :class:StartAgentThreadRequest plus declared variables.

An :class:AgentRecord captures most of what an :class:AgentThread needs to start - system prompt, model profile, seeded messages, declared goals - and leaves a small set of named holes that callers must fill at invoke time. The canonical example is a triage agent whose goal carries a fixed label_vocabulary but a {{dataset.id}} placeholder, so the same agent can be re-run against many datasets without re-declaring the vocabulary.

The record's main invariant - enforced by :meth:_validate_variables_match_placeholders - is that the set of {{...}} placeholders found anywhere in :attr:request_template equals exactly {v.name for v in variables}. A mismatch fails at save time so stale invoke forms can't paper over typos.

Show properties

agent_idstringrequired

org_idstringrequired

namestringrequired

descriptionstring | null

default: null

Show properties

Any of:

string

string

null

null

request_templateStartAgentThreadRequestrequired

Request payload for starting a new agent thread.

Contains the initial messages and configuration for creating a new conversation.

Show properties

client_contextClientViewingContext | null

default: null

Show properties

Any of:

ClientViewingContext

dataset_idsstring[]

file_idsstring[]

collection_idsstring[]

device_idsstring[]

view_idsstring[]

table_stateobject | null

default: null

Show properties

Any of:

object

object

null

null

display_time_anchor_nsinteger | null

default: null

Show properties

Any of:

integer

integer

null

null

display_time_anchor_labelstring | null

default: null

Show properties

Any of:

string

string

null

null

visualizer_stateobject | null

default: null

Show properties

Any of:

object

object

null

null

misc_contextobject | null

default: null

Show properties

Any of:

object

object

null

null

null

null

messagesAgentMessage[]

Show properties

Array of AgentMessage

roleAgentRolerequired

Enumeration of possible roles in an agent thread.

Defines the different participants that can send messages in a thread.

Allowed:userassistantroboto

Show properties

Array of

AgentTextContent | AgentToolUseContent | AgentToolResultContent | AgentErrorContent | AgentDeletedContent | AgentCompressionFillerContent | AgentClientContextEntry

Any of:

AgentTextContent

textstringrequired

AgentToolUseContent

content_typestring

default: "tool_use"

tool_namestringrequired

tool_use_idstringrequired

inputobject | null

default: null

Show properties

Any of:

object

object

null

null

raw_requestobject | null

default: null

Show properties

Any of:

object

object

null

null

AgentToolResultContent

content_typestring

default: "tool_result"

tool_namestringrequired

tool_use_idstringrequired

runtime_msintegerrequired

statusstringrequired

payloadstring | object | any[] | null

default: null

Show properties

Any of:

string

string

object

object

any[]

Array of any

any

null

null

raw_responseobject | null

default: null

Show properties

Any of:

object

object

null

null

AgentErrorContent

content_typestring

default: "error"

error_messagestringrequired

error_codestring | null

default: null

Show properties

Any of:

string

string

null

null

AgentDeletedContent

content_typestring

default: "deleted"

AgentCompressionFillerContent

content_typestring

default: "compression_filler"

AgentClientContextEntry

content_typestring

default: "client_context"

contextClientViewingContextrequired

What the Roboto client (e.g. the Web UI) is currently viewing when the user composed a message.

Passed to the agent as implicit context for resolving deictic references — "this dataset", "those files", "the visualizer state I'm looking at" — that the user would otherwise have to spell out. This type is purely informational; it is not enforced and never gates tool authorization.

Distinct from:

:class:AnalysisScope, which is a hard analysis window honored by individual tools on the server side.
:class:~roboto.ai.goals.AgentGoal, which declares typed outcomes the agent runner must drive the turn to satisfy.

The corresponding wire-format field is client_context (with a one-release context alias for migration).

statusAgentMessageStatus

Enumeration of possible message generation states.

Tracks the lifecycle of message generation from initiation to completion.

Allowed:not_startedgeneratingcompletedfailedcancelled

createdstring<date-time>

system_promptstring | null

default: null

Show properties

Any of:

string

string

null

null

client_toolsClientToolSpec[] | null

default: null

Show properties

Any of:

ClientToolSpec[]

Array of ClientToolSpec

namestringrequired

descriptionstringrequired

input_schemaobjectrequired

null

null

model_profilestring | null

default: null

Show properties

Any of:

string

string

null

null

analysis_scopeAnalysisScope | null

default: null

Show properties

Any of:

AnalysisScope

start_timeinteger | null

default: null

Show properties

Any of:

integer

integer

null

null

end_timeinteger | null

default: null

Show properties

Any of:

integer

integer

null

null

null

null

goalsDatasetSummaryAgentGoal | DatasetTriageGoal | CreateEventsGoal[] | null

default: null

Show properties

Any of:

DatasetSummaryAgentGoal | DatasetTriageGoal | CreateEventsGoal[]

Array of DatasetSummaryAgentGoal | DatasetTriageGoal | CreateEventsGoal

One of:

DatasetSummaryAgentGoal

goal_typestring

default: "dataset_summary"

dataset_idstringrequired

summary_format_spec_promptstring | null

default: null

Show properties

Any of:

string

string

null

null

DatasetTriageGoal

goal_typestring

default: "dataset_triage"

dataset_idstringrequired

label_vocabularyobjectrequired

CreateEventsGoal

goal_typestring

default: "create_events"

dataset_idstringrequired

event_vocabularyobjectrequired

tag_vocabularyobject

collection_idstring | null

default: null

Show properties

Any of:

string

string

null

null

event_focus_promptstring | null

default: null

Show properties

Any of:

string

string

null

null

null

null

invoke_skillsInvokeSkillSpec[]

Show properties

Array of InvokeSkillSpec

skill_idstringrequired

versioninteger | null

default: null

Show properties

Any of:

integer

integer

null

null

available_skillsAvailableSkillSpec[] | null

default: null

Show properties

Any of:

AvailableSkillSpec[]

Array of AvailableSkillSpec

skill_idstringrequired

versioninteger | null

default: null

Show properties

Any of:

integer

integer

null

null

null

null

visibilityThreadVisibility

Read-scope for an :class:AgentThreadRecord.

Set when the thread is created, and changed afterwards only by the thread's creator, via :meth:roboto.ai.agent_thread.AgentThread.set_visibility (POST /v1/ai/threads/<thread_id>/visibility). Roboto admins read every thread but cannot re-scope one they did not create.

Import as :class:roboto.ai.agent_thread.ThreadVisibility.

Allowed:privateorg

variablesTemplateVariable[]

Show properties

Array of TemplateVariable

namestringrequired

typeTemplateVariableType

How a variable's value is interpreted when an agent is launched.

Substitution itself is type-agnostic: every value is spliced in as a string. The type drives two things a caller can observe — the Roboto web app picks a richer input control (dataset picker, device picker), and a typed value is checked for existence when the agent is launched, so a bad id is rejected up front rather than inside the agent's first tool call.

Allowed:stringdataset_iddevice_idcollection_id

descriptionstring | null

default: null

Show properties

Any of:

string

string

null

null

requiredboolean

default: true

defaultstring | null

default: null

Show properties

Any of:

string

string

null

null

collection_content_typeCollectionResourceType | null

default: null

Show properties

Any of:

CollectionResourceType

string

null

null

createdstring<date-time>required

created_bystringrequired

modifiedstring<date-time>required

modified_bystringrequired

400

Thrown when the conversation context (messages, system prompt, tool results) exceeds the model's context window limit.

The token estimate and the model's context limit are not carried on the exception, so a caller cannot read usage numbers off it.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

401

Thrown when authentication fails

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

403

Thrown if an operation would exceed a user or org level limit.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

404

Thrown if a user is attempting to perform an action unrecognized by the Roboto platform.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

409

Thrown if there is a conflict between a resource you're creating and another existing resource

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

410

Thrown if a resource is missing or expired.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

500

An error the platform reported that this SDK release cannot resolve to a specific exception class.

Reported for an element of a :py:class:~roboto.http.BatchResponse whose error names a code this release defines no class for, or that arrived without a code, without a message, or as text that is not an error envelope at all. It carries whatever code and message the platform sent, so a caller handling the failure still learns what went wrong; when no message could be read, the message is the error's raw text.

The error envelope carries no status code, so http_status_code reports the 500 inherited from :py:class:RobotoDomainException rather than the status the failure actually had.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

501

Thrown by shimmed out APIs which have not yet been implemented

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

503

Thrown when a service is unavailable, such as when it's under heavy load and can't accept new requests. This is expected to be transient and ought to be retried.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

504

Thrown when the service times out while processing a request. This is exepcted to be transient and ought to be retried.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

507

Thrown when the server cannot complete the request because the response payload exceeds a storage or transport capacity limit (e.g., Lambda response size). This is NOT expected to be transient and should NOT be retried.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

X-Roboto-Org-IdheaderX-Roboto-User-Idheadernamepath*

Request

curl -X GET 'https://api.roboto.ai/v1/ai/agents/name/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.roboto.ai/v1/ai/agents/name/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.roboto.ai/v1/ai/agents/name/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "data": {
    "agent_id": "string",
    "org_id": "string",
    "name": "string",
    "description": null,
    "request_template": {
      "client_context": null,
      "messages": [
        {
          "role": "user",
          "content": [
            {
              "text": "string"
            }
          ],
          "status": "not_started",
          "created": "2019-08-24T14:15:22Z"
        }
      ],
      "system_prompt": null,
      "client_tools": null,
      "model_profile": null,
      "analysis_scope": null,
      "goals": null,
      "invoke_skills": [
        {
          "skill_id": "string",
          "version": null
        }
      ],
      "available_skills": null,
      "visibility": "private"
    },
    "variables": [
      {
        "name": "string",
        "type": "string",
        "description": null,
        "required": true,
        "default": null,
        "collection_content_type": null
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "modified": "2019-08-24T14:15:22Z",
    "modified_by": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}