v1

latestOpenAPI 3.1.02026-07-267418115.3 KB

GET documents instances

get/api/v1/documents

Query parameters

pageinteger

Page number. Defaults to 1. See Pagination for more details.

per_pageinteger

Number of requested paginated records. Defaults to 50. See Pagination for more details.

sortstring nullable

Optional Mongo-style JSON sort clause, e.g., sort={"created_at": true} to sort by created_at (descending)

wherestring nullable

Optional Mongo-style JSON filter clause, e.g., where={"$uri": {"$eq": "/api/v1/samples/0ee172af60e84f61"}}

Response

$uristring required

created_atstring date-time required

Timestamp for when the object was created on the One Codex platform, encoded as a RFC 3339 timestamp.

filenamestring required

The document filename (e.g., "report.pdf")

sizeinteger nullable required

The size of the document in bytes.

Example response

[
  {
    "$uri": "/api/v1/documents/0d77065796f8d173",
    "downloaders": [
      {
        "__DOLLAR_REF__": "/api/v1/users/a1b2c3d4e5f67890"
      }
    ],
    "uploader": {
      "__DOLLAR_REF__": "/api/v1/users/a1b2c3d4e5f67890"
    }
  }
]