delete_query_workbook

PlaygroundApi.delete_query_workbook(workbook_id, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Delete a workbook

Deletes a workbook and revokes its access entries. Only the workbook owner may call this; editor access is not sufficient. Associated conversation messages are deleted as well, but only in environments where AI services are enabled. Where they are disabled the message records are left behind. Note that an unknown workbook id is reported as HTTP 400 with IPV-1002, not 404.

Parameters:

  • workbook_id (str) – Workbook identifier. (required)

  • role_id (str) – Amorphic role ID the request is authorized against. Must be a role the caller belongs to. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

QueryWorkbookDeleteResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: DELETE /workbooks/{workbook_id}

Parameter examples

Name

In

Example

workbook_id

path

"b1e6c2a0-9f4d-4c7a-8f2e-1a2b3c4d5e6f"

role_id

header

"role-admin"

Success (HTTP 200)

Workbook deleted.

Request / response example

{
  "Message": "Workbook deleted successfully"
}

Errors

Documented error codes: IPV-1002, AUTH-1012.

HTTP 400

Input validation or authorization failure. Body is {“Message”: “<CODE> - <text>”}. Codes: IPV-1002 (workbook id not found), AUTH-1012 (the caller is not the workbook owner).

Unknown workbook id

{
  "Message": "IPV-1002 - Invalid WorkbookId - b1e6c2a0-9f4d-4c7a-8f2e-1a2b3c4d5e6f, resource not found."
}

Caller is not the workbook owner

{
  "Message": "AUTH-1012 - User is not authorized to perform this operation"
}

HTTP 500

Something went wrong at backend