POST
/
objs
/
query
Objs Query
curl --request POST \
  --url https://trace.wandb.ai/objs/query \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "project_id": "user/project",
  "filter": {
    "latest_only": true,
    "object_ids": [
      "my_favorite_model"
    ]
  },
  "limit": 100,
  "offset": 0,
  "sort_by": [
    {
      "direction": "desc",
      "field": "created_at"
    }
  ],
  "metadata_only": true,
  "include_storage_size": true
}'
{
  "objs": [
    {
      "project_id": "<string>",
      "object_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "digest": "<string>",
      "version_index": 123,
      "is_latest": 123,
      "kind": "<string>",
      "base_object_class": "<string>",
      "leaf_object_class": "<string>",
      "val": "<any>",
      "wb_user_id": "<string>",
      "size_bytes": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
project_id
string
required

The ID of the project to query

Examples:

"user/project"

​
filter
object | null

Filter criteria for the query. See ObjectVersionFilter

Examples:
{
  "latest_only": true,
  "object_ids": ["my_favorite_model"]
}
​
limit
integer | null

Maximum number of results to return

Examples:

100

​
offset
integer | null

Number of results to skip before returning

Examples:

0

​
sort_by
SortBy · object[] | null

Sorting criteria for the query results. Currently only supports 'object_id' and 'created_at'.

Examples:
[
  {
    "direction": "desc",
    "field": "created_at"
  }
]
​
metadata_only
boolean | null
default:false

If true, the val column is not read from the database and is empty.All other fields are returned.

​
include_storage_size
boolean | null
default:false

If true, the size_bytes column is returned.

Response

Successful Response

​
objs
ObjSchema · object[]
required