curl --request POST \
  --url "https://api.roe-ai.com/v1/datasets/files/upload/?organization_id=YOUR_ORG_ID" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: multipart/form-data" \
  --form "file=@/path/to/your/file.pdf" \
  --form "dataset_id=YOUR_DATASET_ID"

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "dataset": {
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "name": "default",
    "creator": {
      "id": 1,
      "email": "test@roe-ai.com",
      "first_name": "Test",
      "last_name": "Roe",
      "is_active": true
    },
    "created_at": "2024-04-29T14:11:16.688751-07:00"
  },
  "name": "test1.txt",
  "size": 0,
  "creator": {
    "id": 1,
    "email": "test@roe-ai.com",
    "first_name": "Test",
    "last_name": "Roe",
    "is_active": true
  },
  "created_at": "2024-07-01T16:15:51.964998-07:00"
}

Roe Datasets

Upload File

Mixin for organization access validation. Automatically resolves and validates organization access on every request, making the organization available as self.organization. For API key auth: organization is derived from the key (no org_id param needed). For user auth: organization_id must be provided in the request (kwargs / headers / body / query params). Usage: class MyView(BaseOrganizationAccessMixin, APIView): def get(self, request): # self.organization is automatically available return Response({"org": self.organization.name})

POST

datasets

files

upload

curl --request POST \
  --url "https://api.roe-ai.com/v1/datasets/files/upload/?organization_id=YOUR_ORG_ID" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: multipart/form-data" \
  --form "file=@/path/to/your/file.pdf" \
  --form "dataset_id=YOUR_DATASET_ID"

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "dataset": {
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "name": "default",
    "creator": {
      "id": 1,
      "email": "test@roe-ai.com",
      "first_name": "Test",
      "last_name": "Roe",
      "is_active": true
    },
    "created_at": "2024-04-29T14:11:16.688751-07:00"
  },
  "name": "test1.txt",
  "size": 0,
  "creator": {
    "id": 1,
    "email": "test@roe-ai.com",
    "first_name": "Test",
    "last_name": "Roe",
    "is_active": true
  },
  "created_at": "2024-07-01T16:15:51.964998-07:00"
}

curl --request POST \
  --url "https://api.roe-ai.com/v1/datasets/files/upload/?organization_id=YOUR_ORG_ID" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: multipart/form-data" \
  --form "file=@/path/to/your/file.pdf" \
  --form "dataset_id=YOUR_DATASET_ID"

Query Parameters

organization_id

string<uuid>

Organization ID. This is required for access control. It can be provided via query or request body depending on the endpoint.

Body

multipart/form-data

file

required

File to upload.

organization_id

string

Organization ID. If not provided, file will be uploaded to personal dataset.

Minimum string length: 1

metadata

any

Optional metadata for the file in JSON format.

Response

File uploaded

string<uuid>

required

read-only

dataset

object

required

Show child attributes

name

string

required

Maximum string length: 1024

size

integer

required

Required range: -2147483648 <= x <= 2147483647

creator

object

required

Show child attributes

created_at

string<date-time>

required

read-only

Delete a Dataset Download File