steedos-server-api

Access Steedos Server data, object metadata, and functions via authenticated REST APIs.

1.6k|413|Updated Mar 4, 2019
One-click install
npx skills add https://github.com/steedos/steedos-platform --skill steedos-server-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: steedos-server-api
Source: https://github.com/steedos/steedos-platform/tree/main/skills/steedos-server-api
Command: npx skills add https://github.com/steedos/steedos-platform --skill steedos-server-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Steedos Server API enables developers to securely access data, object schemas, and server functions via REST, eliminating custom integration work.

Core Features & Use Cases

  • RESTful data CRUD: create, read, update, and delete records via /api/v6/data.
  • Object metadata & functions: fetch schemas via /api/v6/objects and invoke server functions via /api/v6/functions.
  • Secure, documented access: Swagger/open API endpoints and AuthGuard-protected endpoints for authenticated clients.

Quick Start

Authenticate with cookie-based or Bearer token authentication, then perform a sample CRUD operation via POST /api/v6/data/:object to verify REST access.

Frequently Asked Questions about steedos-server-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I authenticate REST API requests to a Steedos server?

REST API data CRUD operations on a Steedos server return raw payloads for single-record operations, while list results are wrapped in a { data, totalCount } structure to provide pagination metadata.

Can I retrieve object metadata and schemas through the Steedos REST API?

Invoke server functions via the Steedos REST API by sending requests to the /api/v6/functions endpoint, enabling authenticated client applications to execute server-side logic remotely.

What endpoints are available for Steedos server health checks and public settings?

Steedos server health checks and public settings are available via the /api/v6/health and /api/v6/public/settings endpoints, respectively, allowing you to verify server status and fetch configuration data.

How do I use filters, sorting, and pagination when fetching Steedos data via REST API?

Apply filters, sorting, and pagination when fetching Steedos data via REST API by appending query parameters to the /api/v6/data endpoint, returning list results wrapped as { data, totalCount }.

Does the Steedos REST API support field selection for data queries?

The Steedos REST API supports field selection for data queries on the /api/v6/data endpoint, allowing authenticated clients to specify exactly which fields to return in the response payload.