Indox Auth API - OSLLM AI

User Storage

Download schema

Upload a new file to the user's storage bucket.

POST

/auth/api/v1/storage/files/upload/

Accepts multipart uploads and stores the object in S3. Also records storage usage.

Upload a new file to the user's storage bucket. › Request Body

file

string · binary · required

storage_already_tracked

boolean

Default: false

Upload a new file to the user's storage bucket. › Responses

Serialized representation of a user-managed file.

id

string · uuid · required

file_name

string · required

s3_key

string · required

file_size_bytes

integer · required

storage_bytes_recorded

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

POST/auth/api/v1/storage/files/upload/

import requests

url = "/auth/api/v1/storage/files/upload/"

payload = {
    "file": "file",
    "s3_key": "string",
    "storage_already_tracked": True,
    "related_task_id": "string"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "file": "file",
  "s3_key": "string",
  "storage_already_tracked": true,
  "related_task_id": "string"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "file_name": "file_name",
  "s3_key": "s3_key",
  "file_size_bytes": 0,
  "content_type": "string",
  "storage_bytes_recorded": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "download_url": "string",
  "related_task_id": "string"
}

json

application/json

Register an existing S3 object as a user-managed file.

POST

/auth/api/v1/storage/files/register/

Use when the file is already in S3 (e.g., conversion output). Optionally skip storage bump if already counted.

Register an existing S3 object as a user-managed file. › Request Body

s3_key

string · required

storage_already_tracked

boolean

Default: false

Register an existing S3 object as a user-managed file. › Responses

Serialized representation of a user-managed file.

id

string · uuid · required

file_name

string · required

s3_key

string · required

file_size_bytes

integer · required

storage_bytes_recorded

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

POST/auth/api/v1/storage/files/register/

import requests

url = "/auth/api/v1/storage/files/register/"

payload = {
    "s3_key": "s3_key",
    "file_name": "string",
    "file_size_bytes": 0,
    "content_type": "string",
    "storage_already_tracked": True,
    "related_task_id": "string"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "s3_key": "s3_key",
  "file_name": "string",
  "file_size_bytes": 0,
  "content_type": "string",
  "storage_already_tracked": true,
  "related_task_id": "string"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "file_name": "file_name",
  "s3_key": "s3_key",
  "file_size_bytes": 0,
  "content_type": "string",
  "storage_bytes_recorded": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "download_url": "string",
  "related_task_id": "string"
}

json

application/json

List user-managed files (uploads + conversions).

GET

/auth/api/v1/storage/files/

List user-managed files (uploads + conversions). › query Parameters

page

integer

Default: 1

page_size

integer

Default: 20

sort_by

string

Default: created_at

sort_dir

string

Default: desc

List user-managed files (uploads + conversions). › Responses

Paginated user files with storage metadata.

count

integer · required

total_pages

integer · required

page

integer · required

page_size

integer · required

required

object · required

Storage usage metadata.

object[] · required

GET/auth/api/v1/storage/files/

import requests

url = "/auth/api/v1/storage/files/"

response = requests.get(url)

print(response.text)

python

Example Responses

{
  "count": 0,
  "total_pages": 0,
  "page": 0,
  "page_size": 0,
  "next": "string",
  "previous": "string",
  "storage": {
    "limit_bytes": 0,
    "used_bytes": 0,
    "remaining_bytes": 0,
    "price_per_gb_cents": 0
  },
  "results": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "file_name",
      "s3_key": "s3_key",
      "file_size_bytes": 0,
      "content_type": "string",
      "storage_bytes_recorded": 0,
      "created_at": "2024-08-25T15:00:00Z",
      "updated_at": "2024-08-25T15:00:00Z",
      "download_url": "string",
      "related_task_id": "string"
    }
  ]
}

json

application/json

Generate download URLs for stored files.

POST

/auth/api/v1/storage/files/download/

Generate download URLs for stored files. › Request Body

Payload for downloading one or many user-managed files.

file_ids

string[]

download_all

boolean

Default: false

Generate download URLs for stored files. › Responses

Download URLs for user-managed files.

object[] · required

POST/auth/api/v1/storage/files/download/

import requests

url = "/auth/api/v1/storage/files/download/"

payload = {
    "file_ids": ["00000000-0000-0000-0000-000000000000"],
    "download_all": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "file_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "download_all": true
}

json

Example Responses

{
  "files": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "file_name",
      "file_size_bytes": 0,
      "content_type": "string",
      "download_url": "string"
    }
  ]
}

json

application/json

Download stored files as a ZIP archive.

POST

/auth/api/v1/storage/files/download/zip/

Download stored files as a ZIP archive. › Request Body

Payload for downloading one or many user-managed files.

file_ids

string[]

download_all

boolean

Default: false

Download stored files as a ZIP archive. › Responses

Download URL response.

url

string · required

POST/auth/api/v1/storage/files/download/zip/

import requests

url = "/auth/api/v1/storage/files/download/zip/"

payload = {
    "file_ids": ["00000000-0000-0000-0000-000000000000"],
    "download_all": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "file_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "download_all": true
}

json

Example Responses

{
  "url": "url"
}

json

application/json

Delete stored files and reclaim storage.

POST

/auth/api/v1/storage/files/delete/

Delete stored files and reclaim storage. › Request Body

Payload for deleting one or many user-managed files.

file_ids

string[]

remove_all

boolean

Default: false

Delete stored files and reclaim storage. › Responses

Response model for simple message replies.

message

string · required

POST/auth/api/v1/storage/files/delete/

import requests

url = "/auth/api/v1/storage/files/delete/"

payload = {
    "file_ids": ["00000000-0000-0000-0000-000000000000"],
    "remove_all": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "file_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "remove_all": true
}

json

Example Responses

{
  "message": "message"
}

json

application/json

API Keys Businesses

Indox Auth API - OSLLM AI

User Storage

Download schema

Upload a new file to the user's storage bucket.

POST

/auth/api/v1/storage/files/upload/

Accepts multipart uploads and stores the object in S3. Also records storage usage.

Upload a new file to the user's storage bucket. › Request Body

file

string · binary · required

storage_already_tracked

boolean

Default: false

Upload a new file to the user's storage bucket. › Responses

Serialized representation of a user-managed file.

id

string · uuid · required

file_name

string · required

s3_key

string · required

file_size_bytes

integer · required

storage_bytes_recorded

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

POST/auth/api/v1/storage/files/upload/

import requests

url = "/auth/api/v1/storage/files/upload/"

payload = {
    "file": "file",
    "s3_key": "string",
    "storage_already_tracked": True,
    "related_task_id": "string"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "file": "file",
  "s3_key": "string",
  "storage_already_tracked": true,
  "related_task_id": "string"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "file_name": "file_name",
  "s3_key": "s3_key",
  "file_size_bytes": 0,
  "content_type": "string",
  "storage_bytes_recorded": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "download_url": "string",
  "related_task_id": "string"
}

json

application/json

Register an existing S3 object as a user-managed file.

POST

/auth/api/v1/storage/files/register/

Use when the file is already in S3 (e.g., conversion output). Optionally skip storage bump if already counted.

Register an existing S3 object as a user-managed file. › Request Body

s3_key

string · required

storage_already_tracked

boolean

Default: false

Register an existing S3 object as a user-managed file. › Responses

Serialized representation of a user-managed file.

id

string · uuid · required

file_name

string · required

s3_key

string · required

file_size_bytes

integer · required

storage_bytes_recorded

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

POST/auth/api/v1/storage/files/register/

import requests

url = "/auth/api/v1/storage/files/register/"

payload = {
    "s3_key": "s3_key",
    "file_name": "string",
    "file_size_bytes": 0,
    "content_type": "string",
    "storage_already_tracked": True,
    "related_task_id": "string"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "s3_key": "s3_key",
  "file_name": "string",
  "file_size_bytes": 0,
  "content_type": "string",
  "storage_already_tracked": true,
  "related_task_id": "string"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "file_name": "file_name",
  "s3_key": "s3_key",
  "file_size_bytes": 0,
  "content_type": "string",
  "storage_bytes_recorded": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "download_url": "string",
  "related_task_id": "string"
}

json

application/json

List user-managed files (uploads + conversions).

GET

/auth/api/v1/storage/files/

List user-managed files (uploads + conversions). › query Parameters

page

integer

Default: 1

page_size

integer

Default: 20

sort_by

string

Default: created_at

sort_dir

string

Default: desc

List user-managed files (uploads + conversions). › Responses

Paginated user files with storage metadata.

count

integer · required

total_pages

integer · required

page

integer · required

page_size

integer · required

required

object · required

Storage usage metadata.

object[] · required

GET/auth/api/v1/storage/files/

import requests

url = "/auth/api/v1/storage/files/"

response = requests.get(url)

print(response.text)

python

Example Responses

{
  "count": 0,
  "total_pages": 0,
  "page": 0,
  "page_size": 0,
  "next": "string",
  "previous": "string",
  "storage": {
    "limit_bytes": 0,
    "used_bytes": 0,
    "remaining_bytes": 0,
    "price_per_gb_cents": 0
  },
  "results": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "file_name",
      "s3_key": "s3_key",
      "file_size_bytes": 0,
      "content_type": "string",
      "storage_bytes_recorded": 0,
      "created_at": "2024-08-25T15:00:00Z",
      "updated_at": "2024-08-25T15:00:00Z",
      "download_url": "string",
      "related_task_id": "string"
    }
  ]
}

json

application/json

Generate download URLs for stored files.

POST

/auth/api/v1/storage/files/download/

Generate download URLs for stored files. › Request Body

Payload for downloading one or many user-managed files.

file_ids

string[]

download_all

boolean

Default: false

Generate download URLs for stored files. › Responses

Download URLs for user-managed files.

object[] · required

POST/auth/api/v1/storage/files/download/

import requests

url = "/auth/api/v1/storage/files/download/"

payload = {
    "file_ids": ["00000000-0000-0000-0000-000000000000"],
    "download_all": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "file_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "download_all": true
}

json

Example Responses

{
  "files": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "file_name",
      "file_size_bytes": 0,
      "content_type": "string",
      "download_url": "string"
    }
  ]
}

json

application/json

Download stored files as a ZIP archive.

POST

/auth/api/v1/storage/files/download/zip/

Download stored files as a ZIP archive. › Request Body

Payload for downloading one or many user-managed files.

file_ids

string[]

download_all

boolean

Default: false

Download stored files as a ZIP archive. › Responses

Download URL response.

url

string · required

POST/auth/api/v1/storage/files/download/zip/

import requests

url = "/auth/api/v1/storage/files/download/zip/"

payload = {
    "file_ids": ["00000000-0000-0000-0000-000000000000"],
    "download_all": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "file_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "download_all": true
}

json

Example Responses

{
  "url": "url"
}

json

application/json

Delete stored files and reclaim storage.

POST

/auth/api/v1/storage/files/delete/

Delete stored files and reclaim storage. › Request Body

Payload for deleting one or many user-managed files.

file_ids

string[]

remove_all

boolean

Default: false

Delete stored files and reclaim storage. › Responses

Response model for simple message replies.

message

string · required

POST/auth/api/v1/storage/files/delete/

import requests

url = "/auth/api/v1/storage/files/delete/"

payload = {
    "file_ids": ["00000000-0000-0000-0000-000000000000"],
    "remove_all": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "file_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "remove_all": true
}

json

Example Responses

{
  "message": "message"
}

json

application/json

API Keys Businesses