objectstack-api

Design ObjectStack runtime REST/GraphQL endpoints with auth, error envelopes, and versioning contracts.

22|6|Updated Jan 18, 2026
One-click install
npx skills add https://github.com/objectstack-ai/framework --skill objectstack-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: objectstack-api
Source: https://github.com/objectstack-ai/framework/tree/main/skills/objectstack-api
Command: npx skills add https://github.com/objectstack-ai/framework --skill objectstack-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It prevents broken or inconsistent API integrations by guiding how to design the ObjectStack runtime’s server-side REST/GraphQL endpoints, auth, realtime transport, error envelopes, and versioned contracts.

Core Features & Use Cases

  • Custom endpoint design beyond CRUD: Define bespoke routes (methods, paths, request/response schemas, handler status) that fit ObjectStack’s routing and dispatcher expectations.
  • Auth and authorization contracts: Specify required authentication, permissions, rate limits, and the RBAC/RLS/FLS layers that govern access.
  • Service discovery and reliability: Define how services register with the kernel and how health and readiness are exposed to clients and operators.
  • Consistency and safety guidelines: Apply endpoint naming conventions, error handling expectations, and best practices like idempotent upserts and consistent pagination.

Quick Start

Use the objectstack-api skill to design a custom endpoint route that performs a secure domain action on a record by specifying its path, method, request parameters and body schema, response shapes, and required permissions.

Frequently Asked Questions about objectstack-api

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

FAQPage Schema
How do I design REST and GraphQL endpoints that follow ObjectStack routing conventions?

Design ObjectStack endpoints by defining custom *.endpoint.ts routes with specific HTTP methods, paths, request/response schemas, and handler status semantics that match the runtime dispatcher expectations for consistent API integration.

What's the best way to configure authentication and authorization rules for an API?

Configure API authorization by specifying required authentication providers, least-privilege permissions, rate limits, and RBAC/RLS/FLS access layers to govern secure domain actions across your endpoint routes.

How does service discovery and health checking work with API endpoints?

Service discovery registers services with the ObjectStack kernel and exposes health and readiness checks to clients and operators, ensuring reliable inter-service communication and endpoint availability monitoring.

Can I use Zod schemas for request and response typing in my endpoint definitions?

Yes, endpoint request and response typing requires compatibility with @objectstack/spec Zod schemas (v4+) to ensure standardized validation and consistent API contracts across custom routes.

Why do my API integrations break due to inconsistent error handling?

Inconsistent API errors stem from unstandardized error envelopes. Applying ObjectStack's standardized error handling expectations and versioning contracts prevents broken integrations across endpoint routes.

Are there limitations when defining custom endpoints beyond standard CRUD operations?

Custom endpoints beyond CRUD require strict adherence to ObjectStack endpoint naming conventions, idempotent upserts for safety, and consistent pagination patterns to maintain routing and dispatcher compatibility without breaking contracts.