Harnesslayer Docs
Back to landing

Harnesslayer API

Documentation

Product documentation for the Harnesslayer API. Use v1 to create apps, register uploaded versions, create API and iMessage channels, run responses, manage sessions and profiles, and inspect state, sync, conflict, instance, and history records.

Base URL

https://api.harnesslayer.ai

Version prefix

/v1

Apps

Versions

Channels

Responses

Start

Authentication

Send an API key on every versioned API request. Organization management endpoints use a user API key. All other versioned endpoints use an organization API key. Authorization must be passed in the request headers. API keys are expected to start with dk-.

Authorization: Bearer dk-...

Start

Response format

API responses use a consistent envelope. Successful responses include success: true and a data object. Failed requests include success: false and an error message.

Success

{
  "success": true,
  "data": {}
}

Error

{
  "success": false,
  "error": "message"
}

Start

Common Pagination

List endpoints commonly support these query parameters.

FieldLocationRequiredDescription
pagequerynoPage number. Defaults to 1.
pageSizequerynoPage size. Defaults to 10.

Start

Health

Health checks do not require bearer authentication and can be used by uptime checks or container probes.

GET/healthz

Health check

Returns service health for the API container.

Start

Build flow

Use the Python SDK for this flow when possible. If REST is required, create an app, publish a version from a zip bundle, create a channel, run a response with a custom session id, and poll the response stream until the session ends.

Create app

Publish version

Create channel

Run response

Poll events

Contents

Documentation library

Get Started

OverviewAuth, object model, pagination, and the recommended flow for the Harnesslayer host API.

SDKs

PythonInstall and use the Harnesslayer Python SDK for app, channel, and run flows.TypeScriptInstall and use the Harnesslayer TypeScript SDK for app, channel, and run flows.

API Reference

OrganizationsCreate and update owner-managed organizations.AppsCreate, list, update, and delete apps.VersionsRegister, inspect, download, and sync app versions from uploaded bundles.Access GroupsCreate and manage access groups for usage limits and reset policies.ChannelsCreate and manage API and iMessage channels.ResponsesRun responses and poll streaming events for response instances.SessionsCreate persistent sessions and stream follow-up messages with response chaining.ProfilesCreate, list, update, and delete profiles.WebhooksCreate and update app webhooks for profile creation events.StatesRegister, materialize, inspect, and download profile state snapshots.InstancesInspect response run instances and list execution history by app.SyncInspect sync jobs created by version sync operations.ConflictsInspect conflict records generated during app or profile sync.HistoryInspect history records and list execution history by app.