API Reference

Full reference for the Wingman Protocol REST API. New? Start with the Quickstart guide.

Base URL

https://api.wingmanprotocol.com

Authentication

All requests require the X-Revenue-Key header.

Rate Limits

Free plan — 10 req/min

Pro plan — 300 req/min

Response Format

All responses are JSON. Success responses use {status, data}. Errors use {error, detail}.

// Success
{ "status": "ok", "data": { ... } }

// Error
{ "error": "unauthorized", "detail": "Missing X-Revenue-Key header" }

AI & Chat

POST/v1/chat/completions

OpenAI-compatible chat completions endpoint. Supported models: mistral, deepseek-coder, qwen2.5, claude-sonnet.

Request Body

Field	Type	Notes
model	string	mistral \| deepseek-coder \| qwen2.5 \| claude-sonnet
messages	array	Array of {role, content} objects

Example

curl -X POST https://api.wingmanprotocol.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "X-Revenue-Key: YOUR_API_KEY" \
  -d '{"model": "mistral", "messages": [{"role": "user", "content": "Hello"}]}'

POST/v1/code/review

Submit code for AI-powered review. Returns feedback, suggestions, and potential issues.

Request Body

Field	Type	Notes
code	string	Source code to review
language	string	e.g. python, typescript, go

Example

curl -X POST https://api.wingmanprotocol.com/v1/code/review \
  -H "Content-Type: application/json" \
  -H "X-Revenue-Key: YOUR_API_KEY" \
  -d '{"code": "def foo(): pass", "language": "python"}'

GET/v1/usage

Retrieve your usage statistics — requests made, tokens consumed, and remaining quota for the current billing period.

Example

curl https://api.wingmanprotocol.com/v1/usage \
  -H "X-Revenue-Key: YOUR_API_KEY"

Content Orders

POST/orders/content

Place a content writing order. Fulfilled by AI and reviewed before delivery.

Request Body

Field	Type	Notes
order_type	string	blog_short \| blog_long \| social_pack \| newsletter \| seo_quick \| seo_deep \| ad_copy \| email_sequence \| product_descriptions
topic	string	Subject or title for the content
details	string	Optional — extra context or requirements

Example

curl -X POST https://api.wingmanprotocol.com/orders/content \
  -H "Content-Type: application/json" \
  -H "X-Revenue-Key: YOUR_API_KEY" \
  -d '{"order_type": "blog_short", "topic": "AI in healthcare", "details": "Target audience: CTOs"}'

GET/orders/list

List all content orders associated with your account, including status and delivery details.

Example

curl https://api.wingmanprotocol.com/orders/list \
  -H "X-Revenue-Key: YOUR_API_KEY"

Dev Tasks

POST/dev/tasks

Submit a development task for AI-assisted implementation. Returns a task ID for tracking.

Request Body

Field	Type	Notes
complexity	string	simple \| moderate \| complex
description	string	Plain-language description of the task
repo_url	string	Optional — link to relevant repository

Example

curl -X POST https://api.wingmanprotocol.com/dev/tasks \
  -H "Content-Type: application/json" \
  -H "X-Revenue-Key: YOUR_API_KEY" \
  -d '{"complexity": "simple", "description": "Add rate limiting to Express API"}'

GET/dev/tasks

List all dev tasks submitted under your account, with status and output links.

Example

curl https://api.wingmanprotocol.com/dev/tasks \
  -H "X-Revenue-Key: YOUR_API_KEY"

Ready to build?

Get your API key and make your first request in under a minute.

Quickstart Guide