Skip to main content
GET
/
health
JavaScript
import CompaniesSocial from '@alloy.rest/companies.social';

const client = new CompaniesSocial();

const response = await client.health.check();

console.log(response.status);
{
  "status": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.companies.social/llms.txt

Use this file to discover all available pages before exploring further.

Response

200 - application/json

Service health check

​
status
string
required