Skip to content
EndpointOS/endpointos-smoke-test-d1ab/smoke-feature-requests-api-1780553602023public docs

Smoke Feature Requests API 1780553602023

liveOpenAPI 3.1Draft v1

Temporary EndpointOS production smoke-test project.

Maintained by endpointos-smoke-test-d1abUpdated Jun 4, 20260 resources10,000 requests/month
Introduction

A live REST API reference generated from Smoke Feature Requests API 1780553602023.

This documentation is generated from the project schema in EndpointOS. It shows the public method surface, authentication model, request schemas, response contracts, errors, pagination, usage limits, and OpenAPI export.

Quickstart

Make the first request

Use a project API key with the base URL and one of the generated resource paths. EndpointOS never displays private API keys in public documentation.

  1. Issue a read or write key from the project dashboard.
  2. Send it in Authorization: Bearer sapi_live_xxxxxxxx or x-api-key.
  3. Call one of the generated endpoints below.
  4. Inspect the request log and monthly usage in EndpointOS.
Run itAdd a resource
Add a resource to this project to generate request examples.
Response contractJSON envelope
{
  "data": [],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 0
  }
}

Authentication

API keys on every request

Every public request requires an EndpointOS API key. Key permissions are checked first, then each resource access mode decides which generated methods are exposed.

HeaderValueUse when
AuthorizationBearer sapi_live_xxxxxxxxRecommended for server-to-server calls.
x-api-keysapi_test_xxxxxxxxUseful for curl examples and simple clients.
HeadersEither format works
Authorization: Bearer sapi_live_xxxxxxxx
x-api-key: sapi_test_xxxxxxxx

Base URL

Project-level API namespace

All endpoints below are relative to this base URL. The username and project slug are part of the namespace so different builders can publish APIs with the same project name without collisions.

https://endpointos.dev/api/public/endpointos-smoke-test-d1ab/smoke-feature-requests-api-1780553602023

Resource behavior

Access modes and data sources

Each resource controls its public method surface. API key permissions still apply, but a resource can intentionally expose fewer methods for dataset, lookup, or intake APIs.

Read/write

GET, POST, PATCH, DELETEManaged APIs that need the full record lifecycle.

Read-only

GETPublic datasets, reporting feeds, lookup APIs, and partner data products.

Write-only

POSTLead capture, form submissions, events, and private intake APIs.
No resources have been published for this API yet.

Conventions

Pagination

List endpoints support limit and offset. The default limit is 20 and the maximum limit is 100.

Query parameters
limitnumberoptionalPage size. Defaults to 20 and caps at 100.
offsetnumberoptionalZero-based offset for the first returned record.
List responsePaginated
{
  "data": [
    {
      "id": "rec_abc123",
      "title": "Dark mode",
      "createdAt": "2026-05-11T10:30:00.000Z",
      "updatedAt": "2026-05-11T10:30:00.000Z"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 1
  }
}

Conventions

Filtering

Collection endpoints accept field filters, comparison operators, text search, and deterministic sorting. Plain field=value remains an equality filter.

Filter controls
field=valuestringoptionalEquality filter for a defined field.
field[ne]stringoptionalExclude records matching this value.
field[in]stringoptionalComma-separated values for a field.
field[gte]stringoptionalComparison operators work with number, date, and datetime fields.
qstringoptionalSearch string and enum fields.
sortstringoptionalSort by a field, createdAt, or updatedAt.
Filtered requestGET
GET /records?status[in]=new,planned&votes[gte]=10&sort=-createdAt

Conventions

Errors

EndpointOS returns stable error codes so clients can handle validation, auth, missing records, and usage limits without parsing prose.

CodeStatusMeaning
UNAUTHORIZED401Missing, malformed, or invalid API key.
FORBIDDEN403The API key cannot perform this operation.
PROJECT_NOT_FOUND404The project slug does not resolve to an API.
RESOURCE_NOT_FOUND404The resource slug does not exist in the project.
RECORD_NOT_FOUND404The record id does not exist or was deleted.
VALIDATION_ERROR400The request body failed schema validation.
RATE_LIMITED429The project has reached its monthly request limit.
INTERNAL_ERROR500EndpointOS could not complete the request.
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Field 'title' is required.",
    "details": {
      "field": "title"
    }
  }
}

Conventions

Rate limits

EndpointOS counts public API requests per project each month. When the project reaches its limit, the API returns 429 RATE_LIMITED.

Limit response429 RATE_LIMITED
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Monthly request limit exceeded.",
    "details": {
      "limit": 10000,
      "resetAt": "2026-06-01T00:00:00.000Z"
    }
  }
}

Validation policy

Unknown fields are rejected

EndpointOS rejects fields that are not defined on the resource schema. This keeps generated APIs predictable and prevents accidental writes to undeclared data.

Developer portal

Request API access

Want to call this API? Send the owner an access request. If approved, they'll issue you an API key and a private link to see your usage.

Request API access