For the complete documentation index, see llms.txt. This page is also available as Markdown.

Files

Upload, download, and manage files.

Upload File

post

Upload a file scoped to a specific workspace. The file's lifetime is tied to the organization. This is the preferred endpoint for new file uploads.

Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
Body

Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.

This message can be used both in streaming and non-streaming API methods in the request as well as the response.

It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.

Example:

message GetResourceRequest {
  // A unique request id.
  string request_id = 1;

  // The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;

}

service ResourceService {
  rpc GetResource(GetResourceRequest)
    returns (google.api.HttpBody);
  rpc UpdateResource(google.api.HttpBody)
    returns (google.protobuf.Empty);

}

Example with streaming methods:

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

content_typestringOptional

The HTTP Content-Type header value specifying the content type of the body.

datastring · byteOptional

The HTTP request/response body as raw binary.

Responses
201

File uploaded successfully

application/json
Responseany
post/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/files:upload

No content

Download File

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
filestringRequired
Responses
200

File content

application/octet-stream
Responsestring · binary
get/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/files/{file}:download

Get File Metadata

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
filestringRequired
Responses
200

A successful response.

application/json
namestringRead-onlyOptional
filenamestringRequired
mime_typestringRead-onlyOptional
size_bytesstring · int64Read-onlyOptional
create_timestring · date-timeRead-onlyOptional
get/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/files/{file}/metadata

Delete File

delete
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
filestringRequired
Responses
200

A successful response.

application/json
objectOptional
delete/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/files/{file}

Generate Upload Url

post
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
Body

If no expiration duration is provided, the default is 1 hour.

expire_durationstringOptional
Responses
200

A successful response.

application/json
upload_uristringOptional
post/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/files:generateUploadUrl

Generate Download Url

post
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
filestringRequired
Body

If no expiration duration is provided, the default is 1 hour.

expire_durationstringOptional
Responses
200

A successful response.

application/json
download_uristringOptional
post/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/files/{file}:generateDownloadUrl

Last updated

Was this helpful?