Ouro
  • Docs
  • Blog
Join for freeSign in

Get started

Overview
Introduction
Onboarding

Platform

Introduction
Economics
Teams
Organizations

Developers

Introduction
Quickstart
Libraries
API reference
Python

Concepts

Files
Datasets
Services
Posts
Conversations
Quests
Bitcoin

Files

Last updated 4mo ago

Documentation for the Ouro API Files endpoints.


  • Create a file

    POST /files/create

    Request body

    name

    stringRequired

    visibility

    stringRequired
      publicprivateorganizationmonetized

    metadata

    objectRequired

    path

    stringRequired

    Path to the file in Ouro's storage

    name

    stringRequired

    File name with extension

    type

    string

    File type or MIME type

    description

    string

    org_id

    string

    team_id

    string
  • Read a file

    GET /files/{id}

    Parameters

    id

    string in pathRequired
  • Read a file's data

    GET /files/{id}/data

    Parameters

    id

    string in pathRequired
  • Read file metadata

    GET /files/{id}/metadata

    Parameters

    id

    string in pathRequired
  • Read file stats

    GET /files/{id}/stats

    Parameters

    id

    string in pathRequired
  • Read file permissions

    GET /files/{id}/permissions

    Parameters

    id

    string in pathRequired
  • Update file

    PUT /files/{id}

    Parameters

    id

    string in pathRequired

    Request body

    name

    string

    description

    string

    visibility

    string
      publicprivateorganizationmonetized

    monetization

    string
      pay-to-unlockpay-per-use

    Pricing strategy. Visibility must monetized to set monetization

    price

    number

    team_id

    string
  • Delete file

    DELETE /files/{id}

    Parameters

    id

    string in pathRequired

Create a file asset from a local file.

Retrieves file details as a Pydantic model instance.

Retrieves the raw data content of the file identified by the provided ID.

Retrieves the metadata information for the file with the specified ID, including file size, type, and other properties.

Retrieves statistical information about the file.

Retrieves the current access permissions for the file with the specified ID.

Updates the file with new values for the specified file ID.

Deletes the file identified by the provided ID.

from ouro import Ouro
 
ouro = Ouro(api_key="your_api_key")
 
res = ouro.files.create(
    name="your_file_name",
    description="your_file_description",
    visibility="private",
    metadata={
        "path": "path/to/file",
        "name": "filename.txt",
        "type": "text/plain"
    }
)
id = "3d82308b-0747-45e4-8045-c8f7d2f6c0a6"
 
# Retrieve a file
file = ouro.files.retrieve(id)
# Read file's raw data
data = ouro.files.data(id)
metadata = ouro.files.metadata(id)
stats = ouro.files.stats(id)
permissions = ouro.files.permissions(id)
id = "3d82308b-0747-45e4-8045-c8f7d2f6c0a6"
 
update = {
    "visibility": "private",
    "description": "Updated file description"
}
file = ouro.files.update(id, **update)
data = ouro.files.delete(id)