Docs/API reference

API reference Preview

Three surfaces share one core: the gateway connection-string syntax, the REST API, and the MCP tool set. The full, always-current REST reference will be generated from the OpenAPI specification — this page is a summary until that pipeline ships.

Gateway parameters

All routing is declared in the proxy username. Password can be any value.

connection string

user-{apikey}[-country-{cc}][-session-{sid}][-type-{intent}][-tag-{agent_tag}]

# endpoints
HTTP/HTTPS proxy : gw.aixproxy.com:7777
SOCKS5 proxy     : gw.aixproxy.com:1080

REST API

Authenticated with Authorization: Bearer sk_test_xxx.

endpoints (summary)

POST /v1/personas      # create a persistent identity
GET  /v1/personas      # list personas
GET  /v1/usage         # usage by agent_tag / key / domain
POST /v1/fetch         # Managed Fetch (coming soon)

MCP tools

Exposed by @aixproxy/mcp — see the MCP quickstart for setup.

tools

fetch_url(url, country?, intent?, persona?)  # managed fetch via gateway
create_persona(region, intent?, name?)       # returns a stable p_ handle
get_usage(group_by?)                         # usage and spend attribution

OpenAPI reference — pending. The interactive, per-endpoint reference (schemas, error codes, examples) is generated from the OpenAPI spec and will be published here once the control plane API freezes.

Next steps

Quickstart: MCP

Set up the MCP server in five minutes.

Quickstart: curl

Gateway parameters with worked examples.