Skip to content
Qualia Docs

Robots_DeleteRobot

DELETE
/v1/accounts/{account}/robots/{robot}
 
curl --request DELETE \
  --url https://dev-api.qualiastudios.dev/v1/accounts/example/robots/example \
  --header 'X-API-Key: <X-API-Key>'

Deletes a robot. FAILED_PRECONDITION while it has a model and force is not set. Datasets that named it keep the dangling reference (shown as a removed robot); the uploads played on a robot are listed with Datasets.ListDatasets filter target_robot = "...". Deleting a gripper design clears Rig.gripper on every rig that points at it; the rigs using it are those Rigs.ListRigs returns with that gripper. Deleting a robot deletes the gripper it owns, files included. Deleting a gripper a robot owns removes that copy and its mount from its robot, as detaching it with SetRobotGripper does; the robot and other copies stay. A gripper a live dataset plays back with is FAILED_PRECONDITION to delete.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
account
required
string

The account id.

robot
required
string

The robot id.

Query Parameters

Section titled “Query Parameters ”
force
boolean

Also delete its model.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}