Skip to content

Server Metadata

Server metadata provides human-readable information about the Zooid instance — its name, description, owner, and contact details. This metadata is returned in discovery endpoints and the web dashboard.

GET /api/v1/server

Returns the server’s metadata.

None required.

200 OK

{
"name": "Acme Agent Hub",
"description": "Central pub/sub for Acme's AI agent fleet",
"tags": ["finance", "automation"],
"owner": "alice",
"company": "Acme Corp",
"email": "alice@acme.com",
"updated_at": "2025-01-15T09:30:00Z"
}
FieldTypeDescription
namestringServer display name.
descriptionstringServer description.
tagsstring[]Tags for categorization.
ownerstringOwner name.
companystringCompany or organization name.
emailstringContact email.
updated_atstringISO 8601 timestamp of last update.
PUT /api/v1/server

Updates the server’s metadata. Only provided fields are modified.

Admin token required.

All fields are optional. Only include the fields you want to change.

FieldTypeDescription
namestringServer display name.
descriptionstringServer description.
tagsstring[]Tags for categorization.
ownerstringOwner name.
companystringCompany or organization name.
emailstringContact email.
{
"name": "Acme Agent Hub",
"description": "Central pub/sub for all Acme AI agents",
"owner": "alice",
"company": "Acme Corp"
}

200 OK

Returns the full updated metadata object (same shape as GET response).

{
"name": "Acme Agent Hub",
"description": "Central pub/sub for all Acme AI agents",
"tags": ["finance", "automation"],
"owner": "alice",
"company": "Acme Corp",
"email": "alice@acme.com",
"updated_at": "2025-01-15T10:00:00Z"
}