API Overview

hidettp provides a REST API for programmatic access to bots, executions, and extracted data. Use the API to integrate hidettp into your workflows, trigger bots from external systems, or build custom dashboards.

Base URL

All API requests are made to your Convex deployment URL with the /api/v1 prefix:

https://<your-deployment>.convex.site/api/v1

Authentication

Every request must include an API key in the Authorization header:

Authorization: Bearer <your-api-key>

See Authentication for details on creating and managing API keys.

Response Format

All responses are returned as JSON with the Content-Type: application/json header.

Successful response:

{
  "data": { ... }
}

Error response:

{
  "error": "Description of what went wrong"
}

Pagination

List endpoints use cursor-based pagination. Pass these query parameters:

Parameter	Type	Description
limit	number	Maximum number of items to return per page.
cursor	string	Cursor from the previous response to fetch the next page.

A paginated response includes a cursor field. Pass it as the cursor parameter in the next request to retrieve the following page. When there are no more results, the cursor is null or absent.

Error Responses

The API uses standard HTTP status codes:

Status	Meaning
200	Success
400	Bad request — invalid parameters or missing required fields
401	Unauthorized — missing or invalid API key
403	Forbidden — API key lacks required permissions
404	Not found — resource does not exist or is not accessible
500	Internal server error

Rate Limiting

The API does not enforce explicit rate limits. Throughput is subject to the underlying Convex platform limits.

CORS

CORS is enabled for all origins, allowing API calls from browser-based applications.