Skip to main content

Overview

All Flextell API endpoints are available under the base URL:
https://dev.flextell.ai/api
The API is currently at v0.0.1, the initial release. Endpoint paths and response shapes are subject to change as the API matures. Watch the changelog for updates before upgrading in production.

Authentication

Every request requires a Bearer token in the Authorization header. Obtain a token by completing the OAuth 2.0 flow described in the Authentication page.

Standard request format

Include these headers on every request:
curl --request GET \
  --url https://dev.flextell.ai/api/<endpoint> \
  --header "Authorization: Bearer <your_access_token>" \
  --header "Content-Type: application/json"
For requests with a body (POST, PUT, PATCH), pass your payload as JSON:
curl --request POST \
  --url https://dev.flextell.ai/api/<endpoint> \
  --header "Authorization: Bearer <your_access_token>" \
  --header "Content-Type: application/json" \
  --data '{
    "key": "value"
  }'

Standard response envelope

All responses return JSON. Successful responses follow this general structure:
{
  "data": [ ... ],
  "meta": {
    "cursor": "cursor_eyJpZCI6InJlc18wMDIifQ",
    "has_more": true,
    "total": 100
  }
}
Error responses include a machine-readable code and a human-readable message:
{
  "error": "unauthorized",
  "message": "The access token is missing or invalid."
}

Operations

The API supports the following categories of operations across its resources:
OperationMethodDescription
ListGETRetrieve a paginated list of resources
ReadGETRetrieve a single resource by ID
CreatePOSTCreate a new resource
UpdatePUTReplace an existing resource
ModifyPATCHPartially update an existing resource
DeleteDELETEPermanently remove a resource
Detailed documentation for each endpoint is available in the sub-pages of this section.
Before integrating an endpoint into your code, test it directly with curl. This lets you inspect the raw request and response, confirm your authentication is working, and understand the exact shape of the data — all without writing any application code.