DEVELOPER DOCUMENTATION & API REFERENCE

Build autonomous agents with 2,800+ live tools

One base URL, one token. Call documented registry operations, or proxy real upstream requests to any catalogued endpoint through /call/ with server-side credential injection.

Base URL: https://olywork.com
Auth: X-Olywork-Token
Relay: /call/{endpoint_id}
openapi.json →
Interactive Swagger Console →
>_
CLI 1-Minute Install
Install the lightweight Olywork CLI to test tools and query balances from your terminal.
curl -fsSL https://olywork.com/install.sh | bash
🤖
Claude Code / MCP Server
Connect Claude Code, Cursor, or any Model Context Protocol agent in one command.
claude mcp add --transport http olywork https://olywork.com/mcp
⚡
Direct /call/ HTTP Relay
Make real requests directly. Olywork injects credentials server-side and relays the response.
POST https://olywork.com/call/moz.web.url.metrics
📦
OpenAPI Spec Importer
Convert any OpenAPI 3.0/3.1 or Swagger spec URL into an instant authenticated tool with agent SKILL.md.
olywork tool import-openapi spec.json --generate-skill
🔒
Self-Hosted & Private VPC
Deploy Olywork in your private VPC or on-prem Kubernetes cluster with zero external secret leakage.
docker compose up -d
HOW THE PROTOCOL WORKS

Faithful relay with server-side secrets

1. Verbatim Upstream Relay

You make the provider's real upstream request — path, query params, and body. Olywork injects credentials and returns the provider's exact payload without modification or synthetic wrappers.

2. Zero Connection Locking

Zero database connections are held while an upstream API request is in flight. Balances are reserved and settled in independent transactions to prevent pool exhaustion.

3. BYOK Priority

When you register your team's own API key for a provider, Olywork uses your key immediately and bypasses balance metering completely. Your key always wins.

4. OpenAPI & Custom Tools

Import internal microservices and external REST APIs instantly via Swagger/OpenAPI. Olywork parses schemas, secures tokens in Fernet envelopes, and outputs tailored agent SKILL.md guides.

5. Flexible Deployments

Use Olywork Managed Cloud with 2,896+ master endpoints or deploy on-premise in an air-gapped private VPC via Docker/Kubernetes without holding API keys in agent code.

API Operations Explorer

Browse 141 endpoints across proxy, catalog, orgs, and billing

DELETE /call/{rest}

Call Tool

Params:restx-olywork-org
GET /call/{rest}

Call Tool

Params:restx-olywork-org
OPTIONS /call/{rest}

Call Tool

Params:restx-olywork-org
PATCH /call/{rest}

Call Tool

Params:restx-olywork-org
POST /call/{rest}

Call Tool

Params:restx-olywork-org
PUT /call/{rest}

Call Tool

Params:restx-olywork-org
GET /catalog/endpoints/{endpoint_id}

Catalog Endpoint

Params:endpoint_id
GET /catalog/find

Catalog Find

Params:q
GET /catalog/platforms

Catalog Platforms

GET /catalog/platforms/{slug}

Catalog Platform

Params:sluginclude_hidden
GET /catalog/search

Catalog Search

Params:qlimit
POST /agents/checkin

Agent Checkin

Params:x-olywork-org
GET /auth/cli-token

Auth Cli Token

Params:x-olywork-org
POST /auth/cli/approve

Auth Cli Approve

GET /auth/cli/orgs

Auth Cli Orgs

GET /auth/cli/poll

Auth Cli Poll

Params:login_id
POST /auth/cli/start

Auth Cli Start

POST /auth/email/start

Auth Email Start

POST /auth/email/verify

Auth Email Verify

GET /auth/github

Auth Github

Params:cli
GET /auth/github/callback

Auth Github Callback

Params:codestateolywork_oauth_state
GET /auth/google

Auth Google

Params:cli
GET /auth/google/callback

Auth Google Callback

Params:codestateolywork_oauth_state
GET /auth/invite-signin

Auth Invite Signin

Params:codet
POST /auth/invite-signin

Auth Invite Signin Confirm

POST /auth/logout

Auth Logout

GET /auth/me

Auth Me

POST /auth/revoke-tokens

Auth Revoke Tokens

Params:x-olywork-org
GET /billing

Billing Get

Params:x-olywork-org
POST /billing/autotopup

Billing Autotopup

Params:x-olywork-org
GET /billing/history

Billing History

Params:limitx-olywork-org
POST /billing/portal

Billing Portal

Params:x-olywork-org
POST /billing/topup

Billing Topup

Params:x-olywork-org
GET /bundles

List Bundles

Params:x-olywork-org
GET /bundles/by-name/{name}

Get Bundle By Name

Params:namex-olywork-org
DELETE /bundles/{bundle_id}

Delete Bundle

Params:bundle_idx-olywork-org
GET /bundles/{bundle_id}

Get Bundle

Params:bundle_idx-olywork-org
PATCH /bundles/{bundle_id}

Update Bundle

Params:bundle_idx-olywork-org
GET /calls

List Calls

Params:limitdaysbefore_idapi_key_idx-olywork-org
GET /calls/{call_id}/result

Get Call Result

Params:call_idx-olywork-org
GET /calls/{call_ref}

Get Call

Params:call_refx-olywork-org
GET /connections

List Connections

Params:x-olywork-org
POST /connections/token

Connect With Token

Params:x-olywork-org
DELETE /connections/{secret_id}

Revoke Connection

Params:secret_idx-olywork-org
POST /connections/{secret_id}/extra-credential

Set Extra Credential

Params:secret_idx-olywork-org
POST /connections/{secret_id}/resource

Set Connection Resource

Params:secret_idx-olywork-org
GET /connections/{secret_id}/resources

Connection Resources

Params:secret_idx-olywork-org
POST /demo/sandbox

Demo Sandbox Mint

GET /demo/sandbox/live

Demo Sandbox Live

Params:x-olywork-org
GET /demo/sandbox/skill

Demo Sandbox Skill

Params:x-olywork-org
POST /feedback

Submit Feedback

Params:x-olywork-org
GET /feedback/{feedback_id}

Get Feedback

Params:feedback_idx-olywork-org
GET /health

Get Health

Params:x-olywork-org
POST /health/run

Run Health

Params:all_orgsx-olywork-org
POST /invites/accept

Accept Invite

GET /invites/mine

My Invites

Params:x-olywork-org
POST /invites/{invite_id}/accept

Accept My Invite

Params:invite_idx-olywork-org
POST /media

Host Media

Params:x-olywork-org
GET /meta

Meta

GET /oauth/callback

Oauth Callback

Params:statecodeerror
GET /oauth/providers

Oauth Providers List

POST /oauth/start

Oauth Start

Params:x-olywork-org
GET /oauth/status/{state}

Oauth Status

Params:statex-olywork-org
POST /onboard/accept-teammate

Onboard Accept Teammate

Params:x-olywork-org
POST /onboard/demo

Onboard Demo

Params:x-olywork-org
POST /onboard/reset

Onboard Reset

Params:x-olywork-org
POST /onboard/seed-tool

Onboard Seed Tool

Params:x-olywork-org
POST /onboard/skip

Onboard Skip

Params:x-olywork-org
GET /orgs

List Orgs

Params:x-olywork-org
POST /orgs

Create Org

Params:x-olywork-org
DELETE /orgs/{org_id}

Delete Org

Params:org_idconfirmx-olywork-org
PATCH /orgs/{org_id}

Rename Org

Params:org_idx-olywork-org
GET /orgs/{org_id}/agents

List Agents

Params:org_idx-olywork-org
POST /orgs/{org_id}/agents

Create Agent

Params:org_idx-olywork-org
GET /orgs/{org_id}/agents/observed

List Observed Agents

Params:org_idx-olywork-org
DELETE /orgs/{org_id}/agents/{user_id}

Revoke Agent

Params:org_iduser_idx-olywork-org
GET /orgs/{org_id}/api-keys

List Api Keys

Params:org_idinclude_hiddenx-olywork-org
POST /orgs/{org_id}/api-keys

Create Api Key

Params:org_idx-olywork-org
PATCH /orgs/{org_id}/api-keys/{key_id}

Rename Api Key

Params:org_idkey_idx-olywork-org
POST /orgs/{org_id}/api-keys/{key_id}/disable

Disable Api Key

Params:org_idkey_idx-olywork-org
POST /orgs/{org_id}/api-keys/{key_id}/enable

Enable Api Key

Params:org_idkey_idx-olywork-org
GET /orgs/{org_id}/api-keys/{key_id}/events

List Api Key Events

Params:org_idkey_idx-olywork-org
POST /orgs/{org_id}/api-keys/{key_id}/hide

Hide Api Key

Params:org_idkey_idx-olywork-org
POST /orgs/{org_id}/api-keys/{key_id}/revoke

Revoke Api Key

Params:org_idkey_idx-olywork-org
POST /orgs/{org_id}/api-keys/{key_id}/rotate

Rotate Api Key

Params:org_idkey_idx-olywork-org
GET /orgs/{org_id}/balance

Org Balance

Params:org_idlimitoffsetx-olywork-org
GET /orgs/{org_id}/budgets

List Tag Budgets

Params:org_iddimx-olywork-org
PUT /orgs/{org_id}/budgets/{dim}

Set Tag Default

Params:org_iddimx-olywork-org
DELETE /orgs/{org_id}/budgets/{dim}/{val}

Delete Tag Budget

Params:org_iddimvalx-olywork-org
PUT /orgs/{org_id}/budgets/{dim}/{val}

Set Tag Budget

Params:org_iddimvalx-olywork-org
GET /orgs/{org_id}/deny

List Deny Rules

Params:org_idx-olywork-org
POST /orgs/{org_id}/deny

Create Deny Rule

Params:org_idx-olywork-org
DELETE /orgs/{org_id}/deny/{rule_id}

Delete Deny Rule

Params:org_idrule_idx-olywork-org
GET /orgs/{org_id}/invites

List Invites

Params:org_idx-olywork-org
POST /orgs/{org_id}/invites

Create Invite

Params:org_idx-olywork-org
DELETE /orgs/{org_id}/invites/{invite_id}

Revoke Invite

Params:org_idinvite_idx-olywork-org
POST /orgs/{org_id}/leave

Leave Org

Params:org_idx-olywork-org
GET /orgs/{org_id}/members

List Members

Params:org_idx-olywork-org
DELETE /orgs/{org_id}/members/{user_id}

Remove Member

Params:org_iduser_idx-olywork-org
PATCH /orgs/{org_id}/members/{user_id}

Set Member Role

Params:org_iduser_idx-olywork-org
PATCH /orgs/{org_id}/members/{user_id}/access

Set Member Access

Params:org_iduser_idx-olywork-org
PATCH /orgs/{org_id}/members/{user_id}/cap

Set Member Cap

Params:org_iduser_idx-olywork-org
DELETE /orgs/{org_id}/pins

Clear Capability Pin

Params:org_idcapabilityx-olywork-org
GET /orgs/{org_id}/pins

List Capability Pins

Params:org_idx-olywork-org
POST /orgs/{org_id}/pins

Set Capability Pin

Params:org_idx-olywork-org
GET /orgs/{org_id}/policy/cli-deny

List Cli Deny

Params:org_idx-olywork-org
GET /orgs/{org_id}/projects

List Projects

Params:org_idx-olywork-org
POST /orgs/{org_id}/projects

Create Project

Params:org_idx-olywork-org
DELETE /orgs/{org_id}/projects/{project_id}

Delete Project

Params:org_idproject_idx-olywork-org
GET /orgs/{org_id}/provider-resources

List Provider Resources

Params:org_idproviderkindinclude_deletedsourcex-olywork-org
DELETE /orgs/{org_id}/public-token

Delete Public Token

Params:org_idx-olywork-org
POST /orgs/{org_id}/public-token

Create Public Token

Params:org_idx-olywork-org
GET /orgs/{org_id}/settings

Get Org Settings

Params:org_idx-olywork-org
PATCH /orgs/{org_id}/settings

Set Org Settings

Params:org_idx-olywork-org
GET /orgs/{org_id}/tag-keys

List Tag Keys

Params:org_idx-olywork-org
GET /orgs/{org_id}/usage

Org Usage

Params:org_iddaysx-olywork-org
GET /orgs/{org_id}/usage/by-tag

Usage By Tag

Params:org_idkeydaysx-olywork-org
GET /referrals

My Referrals

Params:x-olywork-org
POST /referrals/code

Mint Referral Code

Params:x-olywork-org
POST /reviews

Submit Review

Params:x-olywork-org
POST /run

Run Tool Server

Params:x-olywork-org
GET /runs

List Runs

Params:limitx-olywork-org
GET /secrets

List Secrets

Params:x-olywork-org
POST /secrets

Create Secret

Params:x-olywork-org
DELETE /secrets/{secret_id}

Delete Secret

Params:secret_idx-olywork-org
PATCH /secrets/{secret_id}

Update Secret

Params:secret_idx-olywork-org
POST /skills

Register Skill

Params:x-olywork-org
POST /skills/analyze

Analyze Skill Folder

Params:x-olywork-org
POST /skills/import

Import Skill Folder

Params:x-olywork-org
GET /skills/samples

Skill Samples

GET /tools

List Tools

Params:x-olywork-org
POST /tools

Create Tool

Params:x-olywork-org
GET /tools/by-name/{name}

Get Tool By Name

Params:namex-olywork-org
POST /tools/openapi/import

Import Openapi

Params:x-olywork-org
POST /tools/openapi/preview

Preview Openapi

Params:x-olywork-org
POST /tools/{name}/grant

Grant Local Run

Params:namex-olywork-org
POST /tools/{name}/run-report

Report Local Run

Params:namex-olywork-org
DELETE /tools/{tool_id}

Delete Tool

Params:tool_idx-olywork-org
PATCH /tools/{tool_id}

Update Tool

Params:tool_idx-olywork-org
GET /usage/me

My Usage

Params:x-olywork-org
POST /users

Register User

Interactive Swagger UI & OpenAPI Spec

Try every API operation in your browser with our interactive test console or download the OpenAPI 3.1 specification.

Open Interactive Console → Download openapi.json