Skip to content
Roboto
Esc
↑↓navigate↵open⌘Jpreview

Update action

Access control

  • requires_resource_owner
  • Restricted tokens need the API scope api.everything_else
PUT/v1/actions/{name}
Authorization
AuthorizationBearer token · headerrequired
Path parameters
namestringrequired
Header parameters
X-Roboto-Org-Idstring
X-Roboto-User-Idstring
Request body
requiredapplication/json
compute_requirementsComputeRequirements | null
Show properties
Any of:
ComputeRequirements
vCPUinteger
default: 512
memory_MiBinteger
default: 1024
gpuboolean
default: false
storage_GiBinteger
default: 21
null
null
null
null
container_parametersContainerParameters | null
Show properties
Any of:
ContainerParameters
commandstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
entry_pointstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
env_varsobject | null
default: null
Show properties
Any of:
object
object
null
null
workdirstring | null
default: null
Show properties
Any of:
string
string
null
null
null
null
null
null
descriptionstring | null
Show properties
Any of:
string
string
null
null
null
null
inheritsActionReference | null
Show properties
Any of:
ActionReference
namestringrequired
digeststring | null
default: null
Show properties
Any of:
string
string
null
null
ownerstring | null
default: null
Show properties
Any of:
string
string
null
null
null
null
null
null
metadata_changesetMetadataChangeset | null
Show properties
Any of:
MetadataChangeset
put_tagsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
string[]
Array of string
string
null
null
remove_tagsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
string[]
Array of string
string
null
null
put_fieldsobject | null
default: null
Show properties
Any of:
object
object
null
null
remove_fieldsstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
string[]
Array of string
string
null
null
replace_allboolean
default: false
null
null
parameter_changesetActionParameterChangeset | null
Show properties
Any of:
ActionParameterChangeset
put_parametersActionParameter[]
Show properties
Array of ActionParameter
namestringrequired
requiredboolean
default: false
descriptionstring | null
default: null
Show properties
Any of:
string
string
null
null
defaultany | null
default: null
Show properties
Any of:
any
any
null
null
remove_parametersstring[]
null
null
uristring | null
Show properties
Any of:
string
string
null
null
null
null
short_descriptionstring | null
Show properties
Any of:
string
string
null
null
null
null
timeoutinteger | null
Show properties
Any of:
integer
integer
null
null
null
null
requires_downloaded_inputsboolean | null
Show properties
Any of:
boolean
boolean
null
null
Responses
200

OK

dataobjectrequired

A wire-transmissible representation of an action.

Show properties
createdstring<date-time>required
created_bystringrequired
modifiedstring<date-time>required
modified_bystringrequired
namestringrequired
org_idstringrequired
accessibilityAccessibility

Controls who can query for and invoke an action.

Accessibility levels determine the visibility and usability of actions within the Roboto platform. Actions can be private to an organization or published publicly in the Action Hub.

Future accessibility levels may include: "user" and/or "team".

Allowed:organizationaction_hub
compute_requirementsComputeRequirements | null
default: null
Show properties
Any of:
ComputeRequirements
vCPUinteger
default: 512
memory_MiBinteger
default: 1024
gpuboolean
default: false
storage_GiBinteger
default: 21
null
null
container_parametersContainerParameters | null
default: null
Show properties
Any of:
ContainerParameters
commandstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
entry_pointstring[] | null
default: null
Show properties
Any of:
string[]
Array of string
string
null
null
env_varsobject | null
default: null
Show properties
Any of:
object
object
null
null
workdirstring | null
default: null
Show properties
Any of:
string
string
null
null
null
null
descriptionstring | null
default: null
Show properties
Any of:
string
string
null
null
digeststring | null
default: null
Show properties
Any of:
string
string
null
null
inheritsActionReference | null
default: null
Show properties
Any of:
ActionReference
namestringrequired
digeststring | null
default: null
Show properties
Any of:
string
string
null
null
ownerstring | null
default: null
Show properties
Any of:
string
string
null
null
null
null
metadataobject
parametersActionParameter[]
Show properties
Array of ActionParameter
namestringrequired
requiredboolean
default: false
descriptionstring | null
default: null
Show properties
Any of:
string
string
null
null
defaultany | null
default: null
Show properties
Any of:
any
any
null
null
publishedstring<date-time> | null
default: null
Show properties
Any of:
string<date-time>
string<date-time>
null
null
requires_downloaded_inputsboolean | null
default: null
Show properties
Any of:
boolean
boolean
null
null
tagsstring[]
uristring | null
default: null
Show properties
Any of:
string
string
null
null
short_descriptionstring | null
default: null
Show properties
Any of:
string
string
null
null
timeoutinteger | null
default: null
Show properties
Any of:
integer
integer
null
null
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
Authorization
Parameters
Bodyapplication/json
Request
curl -X PUT 'https://api.roboto.ai/v1/actions/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "compute_requirements": {
    "vCPU": 512,
    "memory_MiB": 1024,
    "gpu": false,
    "storage_GiB": 21
  },
  "container_parameters": {
    "command": null,
    "entry_point": null,
    "env_vars": null,
    "workdir": null
  },
  "description": "string",
  "inherits": {
    "name": "string",
    "digest": null,
    "owner": null
  },
  "metadata_changeset": {
    "put_tags": null,
    "remove_tags": null,
    "put_fields": null,
    "remove_fields": null,
    "replace_all": false
  },
  "parameter_changeset": {
    "put_parameters": [
      {
        "name": "string",
        "required": false,
        "description": null,
        "default": null
      }
    ],
    "remove_parameters": [
      "string"
    ]
  },
  "uri": "string",
  "short_description": "string",
  "timeout": 0,
  "requires_downloaded_inputs": true
}'
Response
{
  "data": {
    "created": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "modified": "2019-08-24T14:15:22Z",
    "modified_by": "string",
    "name": "string",
    "org_id": "string",
    "accessibility": "organization",
    "compute_requirements": null,
    "container_parameters": null,
    "description": null,
    "digest": null,
    "inherits": null,
    "metadata": {},
    "parameters": [
      {
        "name": "string",
        "required": false,
        "description": null,
        "default": null
      }
    ],
    "published": null,
    "requires_downloaded_inputs": null,
    "tags": [
      "string"
    ],
    "uri": null,
    "short_description": null,
    "timeout": null
  }
}