Files

Overview

There are two file storage contexts. The tenant file store is a shared space where you upload files via the API. The agent workspace is a private sandbox that each agent gets for the duration of its execution. Files flow from the tenant store into agent workspaces, not the other way around.

To get files into an agent, upload them to the tenant store first, then reference their paths when creating an agent or running a test. The system copies the referenced files into the agent's workspace before execution begins. Once in the workspace, the agent can read, write, and organize files freely. It can also download files from the web and upload files to form inputs on pages.

Limits

Individual file uploads are limited to 50 MB. Total tenant storage is subject to your plan's quota. Uploads that would exceed the quota are rejected with a 507 Insufficient Storage response.

List directory entries

Lists non-placeholder files and directories under a tenant-relative path.

Parameters

Example Request

curl "http://app.aiqaramba.com/api/v1/files" \
  -H "Authorization: Bearer $AIQA_API_KEY"

Status Codes

Response Fields (200)

Delete a file or directory

Deletes a file or an empty directory. Deleting a directory that still contains files requires recursive=true and otherwise fails with 409.

Parameters

Example Request

curl -X DELETE "http://app.aiqaramba.com/api/v1/files?path=<path>" \
  -H "Authorization: Bearer $AIQA_API_KEY"

Status Codes

Download a file

Streams one tenant file as an octet stream.

Parameters

Example Request

curl "http://app.aiqaramba.com/api/v1/files/download?path=<path>" \
  -H "Authorization: Bearer $AIQA_API_KEY"

Status Codes

Create a directory

Creates a storage placeholder for an otherwise-empty directory.

Request Body (application/json)

Example Request

curl -X POST "http://app.aiqaramba.com/api/v1/files/mkdir" \
  -H "Authorization: Bearer $AIQA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "path": "<string>"
  }'

Status Codes

Response Fields (200)

Move or rename a file

Request Body (application/json)

Example Request

curl -X POST "http://app.aiqaramba.com/api/v1/files/move" \
  -H "Authorization: Bearer $AIQA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "src_path": "<string>",
    "dst_path": "<string>"
  }'

Status Codes

Response Fields (200)

Upload files

Stores one or more multipart files under an optional relative directory prefix.

Request Body (multipart/form-data)

Example Request

curl -X POST "http://app.aiqaramba.com/api/v1/files/upload" \
  -H "Authorization: Bearer $AIQA_API_KEY" \
  -F 'files=@./files'

Status Codes

Response Fields (200)