socket.help
← Documentation

HTTP API reference

Every endpoint with its parameters, request body, responses, and runnable examples. Anonymous calls need no key; account calls send an API key from your workspace as Authorization: Bearer.

OpenAPI JSON ↗

All endpoints

73 operations in 12 groups. socket.help API version 0.3.0. Open a group for its endpoints, or use the interactive reference below to try them.

Utilities3

Hosted versions of local formatters, encoders, and generators.

  • GET/api/toolsDiscover all tools and availability
  • GET/api/tools/{id}Read tool inputs, options and examples
  • POST/api/tools/{id}/runRun a utility with bounded CPU, memory, and input
Accounts22

Workspace accounts, role-limited keys, and usage. Browser session mutations require Origin matching the configured site.

  • GET/api/plansCompare configured plan allowances
  • GET/api/usageRead the current principal’s hosted execution usage
  • POST/api/auth/registerCreate a free username/password account and session
  • POST/api/auth/loginSign in with a seven-day HttpOnly session cookie
  • POST/api/auth/logoutRevoke the current browser session
  • GET/api/accountRead your user, workspace, effective plan, role, and scopes
  • PATCH/api/accountRename a workspace as an owner or admin
  • GET/api/account/keysList your active keys in the current workspace
  • POST/api/account/keysCreate a scoped key; its secret is returned once
  • DELETE/api/account/keys/{id}Immediately revoke one of your workspace keys
  • GET/api/account/workspacesList your workspace memberships
  • POST/api/account/workspaceSwitch the current browser session’s workspace
  • GET/api/account/membersList current workspace members
  • POST/api/account/invitesCreate a username-bound Team invitation valid for 24 hours
  • POST/api/account/invites/acceptAccept an invitation for your username
  • DELETE/api/account/members/{id}Remove a member and revoke their access to this workspace
  • GET/api/auth/recoveryRead email recovery availability
  • GET/api/account/recoveryRead your verified and pending recovery email
  • POST/api/account/emailSend a verification code after confirming your current password
  • POST/api/account/email/verifyVerify a pending email with a single-use code
  • POST/api/auth/password/forgotRequest a password reset code
  • POST/api/auth/password/resetConsume an email code and replace your password
Lifecycle9

Inspect ownership, retention, and resource expiry.

  • GET/api/account/resourcesList active resources owned by your workspace and total storage
  • POST/api/inboxes/{id}/renewRenew a live resource within the current plan
  • POST/api/mocks/{id}/renewRenew a live resource within the current plan
  • POST/api/files/{id}/renewRenew a live resource within the current plan
  • POST/api/mcp-servers/{id}/renewRenew a live resource within the current plan
  • POST/api/inboxes/{id}/sharingSet visibility or rotate a private access token
  • POST/api/mocks/{id}/sharingSet visibility or rotate a private access token
  • POST/api/files/{id}/sharingSet visibility or rotate a private access token
  • POST/api/mcp-servers/{id}/sharingSet visibility or rotate a private access token
Billing4

Dodo Payments subscriptions. Checkout remains disabled until configured.

  • GET/api/billingRead billing availability and validated recurring prices
  • POST/api/billing/checkoutOpen Dodo Payments subscription checkout for a workspace owner
  • POST/api/billing/portalOpen the workspace owner’s Dodo Payments billing portal
  • POST/billing/webhookReceive signed Dodo Payments subscription lifecycle events
Music library3

Original CC0 instrumental tracks and byte-range audio playback.

  • GET/api/musicList original CC0 tracks
  • GET/api/music/{id}/audio.wavStream or download a music track
  • GET/api/music/{id}/audio.mp3Stream or download a full MP3 arrangement
Webhook inboxes9

Capture and inspect callbacks.

  • POST/api/inboxesCreate a temporary webhook inbox
  • GET/hooks/{id}Capture an incoming request
  • POST/hooks/{id}Capture an incoming request
  • PUT/hooks/{id}Capture an incoming request
  • PATCH/hooks/{id}Capture an incoming request
  • DELETE/hooks/{id}Capture an incoming request
  • GET/api/inboxes/{id}Read inbox expiration and usage
  • DELETE/api/inboxes/{id}Delete an inbox and its history
  • GET/api/inboxes/{id}/requestsRead captured requests in arrival order
Mock APIs5

Manage temporary API configurations.

  • POST/api/mocks/{id}/resetRestore a CRUD mock to its seed records
  • POST/api/mocksCreate a temporary mock API
  • GET/api/mocks/{id}Read mock configuration and usage
  • PUT/api/mocks/{id}Replace mock configuration and reset CRUD records
  • DELETE/api/mocks/{id}Delete a mock API immediately
Mock endpoints5

Call your configured routes.

  • GET/mock/{id}/{path}Call a configured mock route
  • POST/mock/{id}/{path}Call a configured mock route
  • PUT/mock/{id}/{path}Call a configured mock route
  • PATCH/mock/{id}/{path}Call a configured mock route
  • DELETE/mock/{id}/{path}Call a configured mock route
Files5

Share temporary attachments.

  • GET/files/{id}/infoRead shared file metadata without consuming a download
  • POST/api/filesUpload a temporary file
  • GET/api/files/{id}Read file metadata and remaining downloads
  • DELETE/api/files/{id}Delete a file immediately
  • GET/files/{id}Download a shared file
Platform2

Service health.

  • GET/healthCheck process liveness
  • GET/readyCheck database readiness
MCP2

Connect agents through Streamable HTTP at /mcp. Discover available operations with tools/list.

  • POST/mcpSend an MCP message over Streamable HTTP
  • POST/mcp/mock/{id}Send an MCP message over Streamable HTTP
Mock MCP servers4

Configurable static tools for agent integration testing.

  • POST/api/mcp-serversCreate a temporary mock MCP server
  • GET/api/mcp-servers/{id}Read server configuration and usage
  • PUT/api/mcp-servers/{id}Replace the mock tool configuration
  • DELETE/api/mcp-servers/{id}Delete a mock MCP server

Loading API reference…