Get Collection Metadata
curl --request GET \
--url https://api.example.com/api/collections/{collection_id}/metadataimport requests
url = "https://api.example.com/api/collections/{collection_id}/metadata"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/collections/{collection_id}/metadata', 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/api/collections/{collection_id}/metadata",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/collections/{collection_id}/metadata"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/collections/{collection_id}/metadata")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/collections/{collection_id}/metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"base_url": "<string>",
"authentication": {}
}Collections
Get Collection Metadata
Get runtime metadata for API execution
GET
/
api
/
collections
/
{collection_id}
/
metadata
Get Collection Metadata
curl --request GET \
--url https://api.example.com/api/collections/{collection_id}/metadataimport requests
url = "https://api.example.com/api/collections/{collection_id}/metadata"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/collections/{collection_id}/metadata', 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/api/collections/{collection_id}/metadata",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/collections/{collection_id}/metadata"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/collections/{collection_id}/metadata")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/collections/{collection_id}/metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"base_url": "<string>",
"authentication": {}
}Authentication
Supports both Firebase and API Key authentication.Path Parameters
string
required
Collection ID (UUID)
Example Request
curl https://api.sari-platform.com/api/collections/550e8400-e29b-41d4-a716-446655440000/metadata \
-H "X-Client-ID: client_abc123" \
-H "X-API-Key: <api_key>"
Response
Returns runtime metadata needed for API execution.string
Collection ID
string
Collection name
string
Collection description
string
API base URL (from OpenAPI servers)
object
Authentication configuration
Example Response
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Stripe Payment API",
"description": "Payment processing API",
"base_url": "https://api.stripe.com",
"authentication": {
"type": "bearer",
"name": "Authorization",
"value": "Bearer sk_test_xxx"
}
}
Authentication Types
| Type | Description |
|---|---|
apiKey | API key in header or query |
bearer | Bearer token in Authorization header |
basic | Basic auth credentials |
none | No authentication |
Errors
| Status | Description |
|---|---|
| 401 | Invalid authentication |
| 403 | No access to this collection |
| 404 | Collection not found |
⌘I

