API Documentation

Programmatically access all OpDeck tools via REST API with your API key.

Overview

The OpDeck API lets you run any tool programmatically and receive results as structured JSON. Authenticate with your API key and call a single endpoint per tool.

REST JSON API Key Auth

Base URL

https://api.opdeck.co/api/v1

Authentication

Include your API key in every request using one of these headers:

Authorization: Bearer opd_your_api_key_here X-API-Key: opd_your_api_key_here

Generate an API key from your dashboard

Rate Limits

1 request per 10 seconds per API key.

429 responses include a Retry-After header with the number of seconds to wait.

Endpoints

POST /api/v1/tools/:toolId

Execute a tool and receive results synchronously.

GET /api/v1/tools

List all available tools with their parameters. No auth required.

GET /api/v1/docs

Full API documentation as JSON. No auth required.

GET /api/v1/docs/prompt

LLM-friendly plain-text documentation. No auth required.

Code Examples

curl -X POST https://api.opdeck.co/api/v1/tools/ssl \
  -H "Authorization: Bearer opd_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"domain":"example.com"}'

Tool Reference

All tools available via the API. Click to see parameters.

LLM Prompt

Copy the full API documentation as a plain-text prompt, optimized for LLMs like ChatGPT or Claude.

Response Format

Success (200):

{
  "success": true,
  "data": { ... },
  "tool": "ssl",
  "execution_time_ms": 1234
}

Error (4xx/5xx):

{
  "error": "Error description"
}