REST API for Oracle AI Data Platform Workbench

Create a new notebook file or directory

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/contents/{contentPath}

Creates a new, untitled, empty file or directory, or copies an existing notebook to a specified path. For example, a POST call to /api/contents/path with body containing copy_from set to /path/to/OtherNotebook.ipynb creates a new copy of OtherNotebook at the specified path.

Request

Path Parameters

aiDataPlatformId(required): string

The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
contentPath(required): string

The path to the notebook file.
workspaceKey(required): string

The key of the Workspace

Header Parameters

datalake-tenant-id: string

The tenant ID header.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
opc-retry-token: string

Minimum Length: 1

Maximum Length: 64

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.
should-update-recent: boolean

A flag to identify if the recent list should be updated.

Default Value: false

Notebook content to create a new notebook.

Root Schema : CreateContentDetails

Type: object

Path of file to copy. A POST to /api/contents/path creates a New untitled, empty file or directory. A POST to /api/contents/path with body {'copy_from': '/path/to/OtherNotebook.ipynb'} creates a new copy of OtherNotebook in path.

Show Source

copy_from: string

Copy from Path. For example, /path/to/OtherNotebook.ipynb.
ext: string

File format extension
type: string

Type of Content model. Either notebook, file, or directory.

{
    "description":"Path of file to copy. A POST to /api/contents/path creates a New untitled, empty file or directory. A POST to /api/contents/path with body {'copy_from': '/path/to/OtherNotebook.ipynb'} creates a new copy of OtherNotebook in path.",
    "type":"object",
    "properties":{
        "copy_from":{
            "description":"Copy from Path. For example, /path/to/OtherNotebook.ipynb.",
            "type":"string"
        },
        "ext":{
            "description":"File format extension",
            "type":"string"
        },
        "type":{
            "description":"Type of Content model. Either notebook, file, or directory.",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/Content/type"
        }
    }
}

Response

Supported Media Types

application/json

201 Response

Directory or file is successfully created.

Headers

Location: string(url)

URL for the new file.
etag: string

For optimistic concurrency control. See `if-match`.
opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-work-request-id: string

The OCID of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request.

Root Schema : Content

Type: object

Content model provides a programmatic interface to interact with notebooks, files and directories within the AI Data Platform Workbench Notebook environment. Type field is used to describe content types like file, directory or notebook. Other notable fields are content and format. The content and format keys may be null if content is not contained.

Show Source

content(required): object content

Content if requested, otherwise is Null. For Notebook model, this contains a nbformat NotebookNode representing the .ipynb file represented by the model. For File model, content field is always Unicode type. For text-format file models, content simply contains the bytes of the file after decoding as UTF-8. Non-text (base64) files are read as bytes, base64 encoded, and then decoded as UTF-8. For Directory model, content field contains a list of content-free models representing the entities in the directory.
created(required): string(date-time)

Creation timestamp.
description: string

A user-provided description of the file.
format(required): string

Allowed Values: [ "NULL", "json", "text", "base64" ]

Format of content. For Notebook model, format field is always 'json'. For File model, format field is either 'text' or 'base64'. For directory model, format field is always 'json'.
hash: string

[optional] The hexdigest hash string of content, if requested, otherwise null. It cannot be null if hashAlgorithm is defined.
hash_algorithm: string

[optional] The algorithm used to produce the hash, if requested, (otherwise null). It cannot be null if hash is defined. Available algorithms.
last_modified(required): string(date-time)

Last modified timestamp.
mimetype(required): string

Mimetype is only applicable for File model. For other models, it is None. If content is not null, and type is 'file', this contains the mimetype of file. For example, text/plain application/octet-stream. Otherwise this is null.
name(required): string

Name of notebook, file or directory, equivalent to the last part of the path.
path(required): string

Full path for notebook, file or directory.
size: integer

Size of file or notebook in bytes. If no size is provided, defaults to null.
type(required): string

Allowed Values: [ "notebook", "file", "directory" ]

Type of content model.
writable(required): boolean

Indicates whether the requester has permission to edit the file.

{
    "description":"Content model provides a programmatic interface to interact with notebooks, files and directories within the AI Data Platform Workbench Notebook environment.\nType field is used to describe content types like file, directory or notebook. \nOther notable fields are content and format. The content and format keys may be null if content is not contained.\n",
    "type":"object",
    "required":[
        "type",
        "name",
        "path",
        "writable",
        "created",
        "last_modified",
        "mimetype",
        "format",
        "content"
    ],
    "properties":{
        "name":{
            "description":"Name of notebook, file or directory, equivalent to the last part of the path.",
            "type":"string"
        },
        "path":{
            "description":"Full path for notebook, file or directory.",
            "type":"string"
        },
        "type":{
            "description":"Type of content model.",
            "type":"string",
            "enum":[
                "notebook",
                "file",
                "directory"
            ]
        },
        "writable":{
            "description":"Indicates whether the requester has permission to edit the file.",
            "type":"boolean"
        },
        "created":{
            "description":"Creation timestamp.",
            "type":"string",
            "format":"date-time"
        },
        "last_modified":{
            "description":"Last modified timestamp.",
            "type":"string",
            "format":"date-time"
        },
        "size":{
            "description":"Size of file or notebook in bytes. If no size is provided, defaults to null.",
            "type":"integer"
        },
        "mimetype":{
            "description":"Mimetype is only applicable for File model. For other models, it is None. If content is not null, and type is 'file', \nthis contains the mimetype of file. For example, text/plain application/octet-stream. Otherwise this is null.\n",
            "type":"string"
        },
        "content":{
            "description":"Content if requested, otherwise is Null. \nFor Notebook model, this contains a nbformat NotebookNode representing the .ipynb file represented by the model. \nFor File model, content field is always Unicode type. For text-format file models, content simply contains the bytes of the file after decoding as UTF-8. \nNon-text (base64) files are read as bytes, base64 encoded, and then decoded as UTF-8. \nFor Directory model, content field contains a list of content-free models representing the entities in the directory.\n",
            "type":"object"
        },
        "format":{
            "description":"Format of content. For Notebook model, format field is always 'json'. For File model, format field is either 'text' or 'base64'. \nFor directory model, format field is always 'json'.\n",
            "type":"string",
            "enum":[
                "NULL",
                "json",
                "text",
                "base64"
            ]
        },
        "hash":{
            "description":"[optional] The hexdigest hash string of content, if requested, otherwise null. It cannot be null if hashAlgorithm is defined.\n",
            "type":"string"
        },
        "hash_algorithm":{
            "description":"[optional] The algorithm used to produce the hash, if requested, (otherwise null). It cannot be null if hash is defined. \n <a href=\"https://docs.python.org/3/library/hashlib.html#hashlib.algorithms_available\" target=\"_blank\" rel=\"noopener noreferrer\">Available algorithms</a>.\n",
            "type":"string"
        },
        "description":{
            "description":"A user-provided description of the file.",
            "type":"string"
        }
    }
}

Nested Schema : content

Type: object

Content if requested, otherwise is Null. For Notebook model, this contains a nbformat NotebookNode representing the .ipynb file represented by the model. For File model, content field is always Unicode type. For text-format file models, content simply contains the bytes of the file after decoding as UTF-8. Non-text (base64) files are read as bytes, base64 encoded, and then decoded as UTF-8. For Directory model, content field contains a list of content-free models representing the entities in the directory.

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

409 Response

Conflict. Request conflicts with the current state of the resource.

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}