# narrowapi API Reference

narrowapi wraps third-party API calls in scoped, safer endpoints for AI agents.
Use the management API to create actions and tokens, then call proxied actions
through /x/{id}.

## Canonical Contract

OpenAPI (canonical wire contract):
https://narrowapi.com/.well-known/openapi.yaml

Equivalent JSON representation:
https://narrowapi.com/.well-known/openapi.json

If this file and OpenAPI disagree on endpoint behavior, OpenAPI wins.

Agent-oriented reference (this file):
https://narrowapi.com/.well-known/llms.txt
https://narrowapi.com/llms.txt

## Authentication

Management API:
Authorization: Bearer sk_...

Proxy execution:
Authorization: Bearer sxt_...

## Core Endpoints

Actions:
- POST /api/v1/actions
- GET /api/v1/actions
- GET /api/v1/actions/{id}
- PATCH /api/v1/actions/{id}
- DELETE /api/v1/actions/{id}

Tokens:
- POST /api/v1/tokens
- GET /api/v1/tokens
- DELETE /api/v1/tokens/{id}

API Keys:
- POST /api/v1/api-keys
- GET /api/v1/api-keys
- DELETE /api/v1/api-keys/{id}

Agent setup:
- POST /api/v1/setup/agent
  Creates a temporary 24-hour setup API key and returns a copyable prompt.
  This endpoint requires a logged-in browser session.

Proxy:
- POST /x/{id}
  Executes an action with a scoped sxt_ token.

## Limits

Free plan:
- 5 actions max
- 300 executions per calendar month

When the action limit is reached, POST /api/v1/actions returns 403 action_limit_reached.
When the execution limit is reached, POST /x/{id} returns 403 execution_limit_reached
and logs the execution with status quota_exceeded.

## Notes

- Docs index: https://narrowapi.com/docs
- Docs quickstart: https://narrowapi.com/docs/quickstart
- API quickstart: https://narrowapi.com/docs/quickstart/api
- Examples: https://narrowapi.com/docs/examples
- API reference: https://narrowapi.com/docs/api
- Getting help: https://narrowapi.com/docs/help
- Use https://narrowapi.com/.well-known/llms.txt for agent-oriented guidance.
- Use https://narrowapi.com/.well-known/openapi.yaml for authoritative request/response schemas.