Skip to main content
Obselite was designed to be highly extensible and customizable. The RPC API is a powerful tool for building on top of our intelligent platform, allowing you to interact programmatically to automate tasks, create custom workflows, and extend existing functionality. With an efficient and scalable design, the API simplifies integration, making it faster and easier to develop robust extensions and enhance the platform’s capabilities.

​
Requests

​
Endpoint

The public RPC API is available at 
https://api.obselite.com/v0

​
Methods

Requests are either GET to read resources or POST to perform actions. All requests must include the Content-Type header: 
Content-Type: application/json

​
Authentication

Include the secret API token generated from Obselite dashboard in the Authorization header as a Bearer token: 
Authorization: Bearer <SECRET_API_TOKEN>

​
Routing

The routing convention is /{resources}/{action}. Each resource will include CRUD operations:
MethodRoutePurpose
GET/{resources}Read all resources
POST/{resources}/createCreate a single resource
GET/{resources}/readRead a single resource
POST/{resources}/updateUpdate a single resource
POST/{resources}/deleteDelete a single resource

​
Responses

​
Methods

GET requests will either return a list of results with metadata or a single resource. POST requests will return an error, the result of an action, or the new/updated resource.

​
Errors

{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}
PropertyTypeDescription
messagestringHuman-readable description of the error
codestringMachine-readable error code for programmatic handling
issuesarrayList of specific validation or processing errors
issues[].messagestringDetailed message for each individual issue

​
Lists

{
  "items": [...],
  "metadata": {
    "count": 100,
    "isFirstPage": true,
    "isLastPage": false,
    "limit": 20,
    "nextPage": 2,
    "offset": 0,
    "page": 1,
    "pageCount": 5,
    "previousPage": null
  }
}

​
Items

The items array contains the requested resources, sorted by createdAt in descending order.

​
Metadata

The metadata object contains the request’s pagination information.
PropertyTypeDescription
countnumberTotal number of items across all pages
isFirstPagebooleanWhether this is the first page of results
isLastPagebooleanWhether this is the last page of results
limitnumberMaximum number of items per page
nextPagenumberPage number for the next set of results (null if on last page)
offsetnumberNumber of items skipped from the start
pagenumberCurrent page number
pageCountnumberTotal number of available pages
previousPagenumberPage number for the previous set of results (null if on first page)