Objs Query
curl --request POST \
--url https://api.example.com/objs/query \
--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": false,
"include_storage_size": false,
"include_tags_and_aliases": false
}
'import requests
url = "https://api.example.com/objs/query"
payload = {
"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": False,
"include_storage_size": False,
"include_tags_and_aliases": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
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: false,
include_storage_size: false,
include_tags_and_aliases: false
})
};
fetch('https://api.example.com/objs/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/objs/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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' => false,
'include_storage_size' => false,
'include_tags_and_aliases' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/objs/query"
payload := strings.NewReader("{\n \"project_id\": \"user/project\",\n \"filter\": {\n \"latest_only\": true,\n \"object_ids\": [\n \"my_favorite_model\"\n ]\n },\n \"limit\": 100,\n \"offset\": 0,\n \"sort_by\": [\n {\n \"direction\": \"desc\",\n \"field\": \"created_at\"\n }\n ],\n \"metadata_only\": false,\n \"include_storage_size\": false,\n \"include_tags_and_aliases\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/objs/query")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"user/project\",\n \"filter\": {\n \"latest_only\": true,\n \"object_ids\": [\n \"my_favorite_model\"\n ]\n },\n \"limit\": 100,\n \"offset\": 0,\n \"sort_by\": [\n {\n \"direction\": \"desc\",\n \"field\": \"created_at\"\n }\n ],\n \"metadata_only\": false,\n \"include_storage_size\": false,\n \"include_tags_and_aliases\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/objs/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"project_id\": \"user/project\",\n \"filter\": {\n \"latest_only\": true,\n \"object_ids\": [\n \"my_favorite_model\"\n ]\n },\n \"limit\": 100,\n \"offset\": 0,\n \"sort_by\": [\n {\n \"direction\": \"desc\",\n \"field\": \"created_at\"\n }\n ],\n \"metadata_only\": false,\n \"include_storage_size\": false,\n \"include_tags_and_aliases\": false\n}"
response = http.request(request)
puts response.read_body{
"objs": [
{
"project_id": "<string>",
"object_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"digest": "<string>",
"version_index": 123,
"is_latest": 123,
"kind": "<string>",
"base_object_class": "<string>",
"val": "<unknown>",
"deleted_at": "2023-11-07T05:31:56Z",
"leaf_object_class": "<string>",
"wb_user_id": "<string>",
"size_bytes": 123,
"tags": [
"<string>"
],
"aliases": [
"<string>"
]
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Requête d’objets
POST
/
objs
/
query
Objs Query
curl --request POST \
--url https://api.example.com/objs/query \
--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": false,
"include_storage_size": false,
"include_tags_and_aliases": false
}
'import requests
url = "https://api.example.com/objs/query"
payload = {
"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": False,
"include_storage_size": False,
"include_tags_and_aliases": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
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: false,
include_storage_size: false,
include_tags_and_aliases: false
})
};
fetch('https://api.example.com/objs/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/objs/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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' => false,
'include_storage_size' => false,
'include_tags_and_aliases' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/objs/query"
payload := strings.NewReader("{\n \"project_id\": \"user/project\",\n \"filter\": {\n \"latest_only\": true,\n \"object_ids\": [\n \"my_favorite_model\"\n ]\n },\n \"limit\": 100,\n \"offset\": 0,\n \"sort_by\": [\n {\n \"direction\": \"desc\",\n \"field\": \"created_at\"\n }\n ],\n \"metadata_only\": false,\n \"include_storage_size\": false,\n \"include_tags_and_aliases\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/objs/query")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"user/project\",\n \"filter\": {\n \"latest_only\": true,\n \"object_ids\": [\n \"my_favorite_model\"\n ]\n },\n \"limit\": 100,\n \"offset\": 0,\n \"sort_by\": [\n {\n \"direction\": \"desc\",\n \"field\": \"created_at\"\n }\n ],\n \"metadata_only\": false,\n \"include_storage_size\": false,\n \"include_tags_and_aliases\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/objs/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"project_id\": \"user/project\",\n \"filter\": {\n \"latest_only\": true,\n \"object_ids\": [\n \"my_favorite_model\"\n ]\n },\n \"limit\": 100,\n \"offset\": 0,\n \"sort_by\": [\n {\n \"direction\": \"desc\",\n \"field\": \"created_at\"\n }\n ],\n \"metadata_only\": false,\n \"include_storage_size\": false,\n \"include_tags_and_aliases\": false\n}"
response = http.request(request)
puts response.read_body{
"objs": [
{
"project_id": "<string>",
"object_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"digest": "<string>",
"version_index": 123,
"is_latest": 123,
"kind": "<string>",
"base_object_class": "<string>",
"val": "<unknown>",
"deleted_at": "2023-11-07T05:31:56Z",
"leaf_object_class": "<string>",
"wb_user_id": "<string>",
"size_bytes": 123,
"tags": [
"<string>"
],
"aliases": [
"<string>"
]
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Corps
application/json
The ID of the project to query
Exemple:
"user/project"
Filter criteria for the query. See ObjectVersionFilter
Show child attributes
Show child attributes
Exemple:
{
"latest_only": true,
"object_ids": ["my_favorite_model"]
}
Maximum number of results to return
Exemple:
100
Number of results to skip before returning
Exemple:
0
Sorting criteria for the query results. Currently only supports 'object_id' and 'created_at'.
Show child attributes
Show child attributes
Exemple:
[
{
"direction": "desc",
"field": "created_at"
}
]
If true, the val column is not read from the database and is empty.All other fields are returned.
If true, the size_bytes column is returned.
If true, tags and aliases are fetched and included in the response.
Réponse
Successful Response
Show child attributes
Show child attributes
Dernière modification le 30 septembre 2026
Cette page vous a-t-elle été utile ?