Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.snorbe.deskrex.ai/llms.txt

Use this file to discover all available pages before exploring further.

API Reference

The Snorbe API lets you call Snorbe’s research agents programmatically from external applications and scripts.

Authentication

All API requests require an API key. You can create API keys from the API Keys page in the dashboard. Include the API key in your request headers using one of these formats:
# Authorization header (recommended)
Authorization: Bearer snorbe_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# Or x-api-key header
x-api-key: snorbe_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
API keys are shown only once when created. If you lose a key, create a new one.

Base URL

https://app.snorbe.deskrex.ai/api/v1

Interactive API Reference

A Scalar-powered UI is available for browsing, searching, and executing every endpoint from your browser.

Snorbe API Reference (Scalar UI)

  • Browse parameters, responses, and code samples for every endpoint
  • Use “Try it out” to send real requests with your own API key
  • Conforms to OpenAPI 3.1

OpenAPI JSON

The machine-readable API spec is available as OpenAPI JSON (the Scalar UI uses this spec under the hood).
curl "https://app.snorbe.deskrex.ai/api/v1/openapi.json"
To print only the available paths:
curl -s "https://app.snorbe.deskrex.ai/api/v1/openapi.json" | jq -r '.paths | keys[]'

Rate Limits

Each API key is limited to 100 requests per minute. Exceeding the limit returns 429 Too Many Requests.

Endpoints

Agent Execution

EndpointMethodDescription
/agent/runPOSTExecute agent (non-streaming)
/agent/run/streamPOSTExecute agent (SSE streaming)
/agent/run/stream/{runId}POSTResume agent run (SSE streaming)
/agent/run/{runId}/statusGETGet execution status
/agent/run/{runId}/resumePOSTResume agent run (non-streaming)

HITL (Human-in-the-Loop)

EndpointMethodDescription
/agent/run/{runId}/plan/answerPOSTAnswer plan review questions
/agent/run/{runId}/plan/confirmPOSTConfirm plan
/agent/run/{runId}/plan/skipPOSTSkip plan review
/agent/run/{runId}/report/answerPOSTAnswer report review questions
/agent/run/{runId}/report/confirmPOSTConfirm report
/agent/run/{runId}/matrix/answerPOSTAnswer matrix review questions
/agent/run/{runId}/matrix/confirmPOSTConfirm matrix

Workspace & Turns

EndpointMethodDescription
/workspaceGETGet workspace information associated with the API key
/turn/listGETList turn history with pagination

Browser Control

EndpointMethodDescription
/browser/answer-questionPOSTAnswer a question asked by the browser agent
/browser/spontaneous-inputPOSTSend an extra instruction to an active browser session
/browser/answer-question-with-filesPOSTAnswer a browser question with files
/browser/spontaneous-input-with-filesPOSTSend an extra browser instruction with files

Agent Management

EndpointMethodDescription
/agent/listGETList agents in a workspace

Secrets

EndpointMethodDescription
/secretPOSTRegister secrets such as API keys for agent execution

Graph Data

EndpointMethodDescription
/graph/workspaceGETGet workspace graph data
/graph/entitiesGETList entities with filtering, search, and pagination
/graph/edgesGETList edges (relationships) by entity IDs

Agent Skill

PageDescription
Agent SkillInstall the Snorbe API skill for Claude Code / Cursor / Codex / Google Antigravity