Skip to main content
GET
/
api
/
collections
/
{collection_id}
/
metadata
Get Collection Metadata
curl --request GET \
  --url https://api.example.com/api/collections/{collection_id}/metadata
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "base_url": "<string>",
  "authentication": {}
}

​
Authentication

Supports both Firebase and API Key authentication.

​
Path Parameters

​
collection_id
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.
​
id
string
Collection ID
​
name
string
Collection name
​
description
string
Collection description
​
base_url
string
API base URL (from OpenAPI servers)
​
authentication
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

TypeDescription
apiKeyAPI key in header or query
bearerBearer token in Authorization header
basicBasic auth credentials
noneNo authentication

​
Errors

StatusDescription
401Invalid authentication
403No access to this collection
404Collection not found