​
Generated API Reference

Generated from SynapseX service OpenAPI specs. Fern/generated clients should use these contracts as source of truth.

​
Services

ServiceVersionPathsSchemas
api-gateway1.0.0418
billing-service1.0.05822
llm-router-service1.0.01013
mcp-router-service1.0.0166
research-mcp-service0.1.030

​
Endpoints

​
api-gateway

MethodPathTagsSummaryOperation ID
GET/healthHealthhealth_health_get
GET/v1/agentsList Agentslist_agents_v1_agents_get
POST/v1/agentsCreate Agentcreate_agent_v1_agents_post
GET/v1/agents/jobsProxy Agent Jobsproxy_agent_jobs_v1_agents_jobs_get
POST/v1/agents/jobsProxy Agent Jobsproxy_agent_jobs_v1_agents_jobs_get
DELETE/v1/agents/jobs/{job_path}Proxy Agent Job Pathproxy_agent_job_path_v1_agents_jobs__job_path__patch
GET/v1/agents/jobs/{job_path}Proxy Agent Job Pathproxy_agent_job_path_v1_agents_jobs__job_path__patch
PATCH/v1/agents/jobs/{job_path}Proxy Agent Job Pathproxy_agent_job_path_v1_agents_jobs__job_path__patch
POST/v1/agents/jobs/{job_path}Proxy Agent Job Pathproxy_agent_job_path_v1_agents_jobs__job_path__patch
PUT/v1/agents/jobs/{job_path}Proxy Agent Job Pathproxy_agent_job_path_v1_agents_jobs__job_path__patch
GET/v1/agents/profilesList Agent Profileslist_agent_profiles_v1_agents_profiles_get
DELETE/v1/agents/{agent_id}Delete Agentdelete_agent_v1_agents__agent_id__delete
GET/v1/agents/{agent_id}Get Agentget_agent_v1_agents__agent_id__get
PUT/v1/agents/{agent_id}Update Agentupdate_agent_v1_agents__agent_id__put
POST/v1/agents/{agent_id}/deployDeploy Agentdeploy_agent_v1_agents__agent_id__deploy_post
POST/v1/agents/{agent_id}/invokeInvoke Agentinvoke_agent_v1_agents__agent_id__invoke_post
GET/v1/agents/{agent_id}/logsGet Agent Logsget_agent_logs_v1_agents__agent_id__logs_get
POST/v1/auth/google/callbackGoogle Callbackgoogle_callback_v1_auth_google_callback_post
GET/v1/auth/google/startGoogle Auth Startgoogle_auth_start_v1_auth_google_start_get
GET/v1/auth/keysProxy Auth Keysproxy_auth_keys_v1_auth_keys_get
POST/v1/auth/keysProxy Auth Keysproxy_auth_keys_v1_auth_keys_get
DELETE/v1/auth/keys/{key_id}Proxy Auth Keyproxy_auth_key_v1_auth_keys__key_id__delete
GET/v1/auth/keys/{key_id}Proxy Auth Keyproxy_auth_key_v1_auth_keys__key_id__delete
POST/v1/auth/loginLoginlogin_v1_auth_login_post
GET/v1/auth/meMeme_v1_auth_me_get
POST/v1/auth/registerRegisterregister_v1_auth_register_post
DELETE/v1/billing/{billing_path}Proxy Billingproxy_billing_v1_billing__billing_path__patch
GET/v1/billing/{billing_path}Proxy Billingproxy_billing_v1_billing__billing_path__patch
PATCH/v1/billing/{billing_path}Proxy Billingproxy_billing_v1_billing__billing_path__patch
POST/v1/billing/{billing_path}Proxy Billingproxy_billing_v1_billing__billing_path__patch
PUT/v1/billing/{billing_path}Proxy Billingproxy_billing_v1_billing__billing_path__patch
POST/v1/chat/completionsProxy Chat Completionsproxy_chat_completions_v1_chat_completions_post
GET/v1/eventsProxy Events Rootproxy_events_root_v1_events_get
POST/v1/eventsProxy Events Rootproxy_events_root_v1_events_get
DELETE/v1/events/{event_path}Proxy Eventsproxy_events_v1_events__event_path__patch
GET/v1/events/{event_path}Proxy Eventsproxy_events_v1_events__event_path__patch
PATCH/v1/events/{event_path}Proxy Eventsproxy_events_v1_events__event_path__patch
POST/v1/events/{event_path}Proxy Eventsproxy_events_v1_events__event_path__patch
POST/v1/mcp/askProxy Mcp Askproxy_mcp_ask_v1_mcp_ask_post
POST/v1/mcp/executeProxy Mcp Executeproxy_mcp_execute_v1_mcp_execute_post
POST/v1/mcp/planProxy Mcp Planproxy_mcp_plan_v1_mcp_plan_post
GET/v1/mcp/plansProxy Mcp Plansproxy_mcp_plans_v1_mcp_plans_get
POST/v1/mcp/routeProxy Mcp Routeproxy_mcp_route_v1_mcp_route_post
GET/v1/mcp/router/toolsProxy Mcp Router Toolsproxy_mcp_router_tools_v1_mcp_router_tools_get
GET/v1/mcp/serversProxy Mcp Serversproxy_mcp_servers_v1_mcp_servers_get
POST/v1/mcp/serversProxy Mcp Serversproxy_mcp_servers_v1_mcp_servers_get
GET/v1/mcp/toolsList Mcp Toolslist_mcp_tools_v1_mcp_tools_get
POST/v1/mcp/tools/executeExecute Mcp Toolexecute_mcp_tool_v1_mcp_tools_execute_post
GET/v1/mcp/tools/{name}Get Mcp Toolget_mcp_tool_v1_mcp_tools__name__get
GET/v1/model-registry/modelsProxy Model Registry Rootproxy_model_registry_root_v1_model_registry_models_get
POST/v1/model-registry/modelsProxy Model Registry Rootproxy_model_registry_root_v1_model_registry_models_get
DELETE/v1/model-registry/models/{model_path}Proxy Model Registryproxy_model_registry_v1_model_registry_models__model_path__patch
GET/v1/model-registry/models/{model_path}Proxy Model Registryproxy_model_registry_v1_model_registry_models__model_path__patch
PATCH/v1/model-registry/models/{model_path}Proxy Model Registryproxy_model_registry_v1_model_registry_models__model_path__patch
POST/v1/model-registry/models/{model_path}Proxy Model Registryproxy_model_registry_v1_model_registry_models__model_path__patch
GET/v1/modelsProxy Modelsproxy_models_v1_models_get
GET/v1/telemetry/{telemetry_path}Proxy Telemetryproxy_telemetry_v1_telemetry__telemetry_path__get
POST/v1/telemetry/{telemetry_path}Proxy Telemetryproxy_telemetry_v1_telemetry__telemetry_path__get
GET/v1/tenantsProxy Tenants Rootproxy_tenants_root_v1_tenants_get
POST/v1/tenantsProxy Tenants Rootproxy_tenants_root_v1_tenants_get
DELETE/v1/tenants/{tenant_path}Proxy Tenantsproxy_tenants_v1_tenants__tenant_path__patch
GET/v1/tenants/{tenant_path}Proxy Tenantsproxy_tenants_v1_tenants__tenant_path__patch
PATCH/v1/tenants/{tenant_path}Proxy Tenantsproxy_tenants_v1_tenants__tenant_path__patch
POST/v1/tenants/{tenant_path}Proxy Tenantsproxy_tenants_v1_tenants__tenant_path__patch
DELETE/v1/updates/{update_path}Proxy Updatesproxy_updates_v1_updates__update_path__patch
GET/v1/updates/{update_path}Proxy Updatesproxy_updates_v1_updates__update_path__patch
PATCH/v1/updates/{update_path}Proxy Updatesproxy_updates_v1_updates__update_path__patch
POST/v1/updates/{update_path}Proxy Updatesproxy_updates_v1_updates__update_path__patch
DELETE/v1/usage/{usage_path}Proxy Usageproxy_usage_v1_usage__usage_path__patch
GET/v1/usage/{usage_path}Proxy Usageproxy_usage_v1_usage__usage_path__patch
PATCH/v1/usage/{usage_path}Proxy Usageproxy_usage_v1_usage__usage_path__patch
POST/v1/usage/{usage_path}Proxy Usageproxy_usage_v1_usage__usage_path__patch
PUT/v1/usage/{usage_path}Proxy Usageproxy_usage_v1_usage__usage_path__patch
DELETE/v1/webhooks/{webhook_path}Proxy Webhooksproxy_webhooks_v1_webhooks__webhook_path__patch
GET/v1/webhooks/{webhook_path}Proxy Webhooksproxy_webhooks_v1_webhooks__webhook_path__patch
PATCH/v1/webhooks/{webhook_path}Proxy Webhooksproxy_webhooks_v1_webhooks__webhook_path__patch
POST/v1/webhooks/{webhook_path}Proxy Webhooksproxy_webhooks_v1_webhooks__webhook_path__patch
GET/v1/workspacesProxy Workspaces Rootproxy_workspaces_root_v1_workspaces_get
POST/v1/workspacesProxy Workspaces Rootproxy_workspaces_root_v1_workspaces_get
DELETE/v1/workspaces/{workspace_path}Proxy Workspacesproxy_workspaces_v1_workspaces__workspace_path__patch
GET/v1/workspaces/{workspace_path}Proxy Workspacesproxy_workspaces_v1_workspaces__workspace_path__patch
PATCH/v1/workspaces/{workspace_path}Proxy Workspacesproxy_workspaces_v1_workspaces__workspace_path__patch
POST/v1/workspaces/{workspace_path}Proxy Workspacesproxy_workspaces_v1_workspaces__workspace_path__patch

​
billing-service

MethodPathTagsSummaryOperation ID
GET/healthHealthhealth_health_get
GET/v1/agents/pricingGet Agent Pricingget_agent_pricing_v1_agents_pricing_get
GET/v1/credits/meGet My Creditsget_my_credits_v1_credits_me_get
GET/v1/credits/me/ledgerGet My Credits Ledgerget_my_credits_ledger_v1_credits_me_ledger_get
GET/v1/credits/packagesGet Credit Packagesget_credit_packages_v1_credits_packages_get
GET/v1/credits/{tenant_id}Get Creditsget_credits_v1_credits__tenant_id__get
POST/v1/credits/{tenant_id}/buyBuy Creditsbuy_credits_v1_credits__tenant_id__buy_post
GET/v1/credits/{tenant_id}/ledgerGet Credits Ledgerget_credits_ledger_v1_credits__tenant_id__ledger_get
GET/v1/gateway/modelsList Gateway Modelslist_gateway_models_v1_gateway_models_get
GET/v1/gateway/models/{tier}List Models By Tierlist_models_by_tier_v1_gateway_models__tier__get
GET/v1/gateway/providersList Gateway Providerslist_gateway_providers_v1_gateway_providers_get
GET/v1/invoices/{tenant_id}List Invoiceslist_invoices_v1_invoices__tenant_id__get
GET/v1/limits/{tenant_id}Check Limitscheck_limits_v1_limits__tenant_id__get
POST/v1/meters/agents/reportReport Agent Meter Usagereport_agent_meter_usage_v1_meters_agents_report_post
POST/v1/meters/llm/reportReport Llm Meter Usagereport_llm_meter_usage_v1_meters_llm_report_post
POST/v1/meters/reportReport Llm Usagereport_llm_usage_v1_meters_report_post
GET/v1/plansList Planslist_plans_v1_plans_get
GET/v1/plans/agentsList Agent Planslist_agent_plans_v1_plans_agents_get
GET/v1/plans/agents/metadataGet Agent Plans Metadataget_agent_plans_metadata_v1_plans_agents_metadata_get
GET/v1/plans/apiList Api Planslist_api_plans_v1_plans_api_get
GET/v1/plans/chatList Chat Planslist_chat_plans_v1_plans_chat_get
GET/v1/plans/chat/metadataGet Chat Plans Metadataget_chat_plans_metadata_v1_plans_chat_metadata_get
GET/v1/plans/llmList Llm Planslist_llm_plans_v1_plans_llm_get
GET/v1/subscription/agents/{tenant_id}Get Agent Subscriptionget_agent_subscription_v1_subscription_agents__tenant_id__get
POST/v1/subscription/agents/{tenant_id}/checkoutCreate Agent Checkoutcreate_agent_checkout_v1_subscription_agents__tenant_id__checkout_post
POST/v1/subscription/agents/{tenant_id}/update-planUpdate Agent Planupdate_agent_plan_v1_subscription_agents__tenant_id__update_plan_post
GET/v1/subscription/chat/{tenant_id}Get Chat Subscriptionget_chat_subscription_v1_subscription_chat__tenant_id__get
POST/v1/subscription/chat/{tenant_id}/checkoutCreate Chat Checkoutcreate_chat_checkout_v1_subscription_chat__tenant_id__checkout_post
POST/v1/subscription/chat/{tenant_id}/update-planUpdate Chat Planupdate_chat_plan_v1_subscription_chat__tenant_id__update_plan_post
POST/v1/subscription/checkoutCreate Checkout Sessioncreate_checkout_session_v1_subscription_checkout_post
GET/v1/subscription/me/agentsGet My Agent Subscriptionget_my_agent_subscription_v1_subscription_me_agents_get
POST/v1/subscription/me/agents/checkoutCreate My Agent Checkoutcreate_my_agent_checkout_v1_subscription_me_agents_checkout_post
GET/v1/subscription/me/apiGet My Api Subscriptionget_my_api_subscription_v1_subscription_me_api_get
POST/v1/subscription/me/api/checkoutCreate Api Checkoutcreate_api_checkout_v1_subscription_me_api_checkout_post
GET/v1/subscription/me/chatGet My Chat Subscriptionget_my_chat_subscription_v1_subscription_me_chat_get
POST/v1/subscription/me/chat/checkoutCreate My Chat Checkoutcreate_my_chat_checkout_v1_subscription_me_chat_checkout_post
GET/v1/subscription/me/llmGet My Llm Subscriptionget_my_llm_subscription_v1_subscription_me_llm_get
POST/v1/subscription/me/llm/checkoutCreate Llm Checkoutcreate_llm_checkout_v1_subscription_me_llm_checkout_post
GET/v1/subscription/{tenant_id}Get Subscriptionget_subscription_v1_subscription__tenant_id__get
POST/v1/subscription/{tenant_id}/cancelCancel Subscriptioncancel_subscription_v1_subscription__tenant_id__cancel_post
GET/v1/subscription/{tenant_id}/portalBilling Portalbilling_portal_v1_subscription__tenant_id__portal_get
POST/v1/subscription/{tenant_id}/update-planUpdate Planupdate_plan_v1_subscription__tenant_id__update_plan_post
POST/v1/usage/agents/reportReport Agent Usagereport_agent_usage_v1_usage_agents_report_post
POST/v1/usage/chat/reportReport Chat Usagereport_chat_usage_v1_usage_chat_report_post
GET/v1/usage/meMy Llm Usagemy_llm_usage_v1_usage_me_get
GET/v1/usage/me/agentsMy Agent Usagemy_agent_usage_v1_usage_me_agents_get
GET/v1/usage/me/apiGet My Api Usageget_my_api_usage_v1_usage_me_api_get
GET/v1/usage/me/chatMy Chat Usagemy_chat_usage_v1_usage_me_chat_get
GET/v1/usage/me/llmGet My Llm Usageget_my_llm_usage_v1_usage_me_llm_get
GET/v1/usage/me/quotaMy Quotamy_quota_v1_usage_me_quota_get
GET/v1/usage/me/summaryMy Usage Summarymy_usage_summary_v1_usage_me_summary_get
GET/v1/usage/{tenant_id}Get Usageget_usage_v1_usage__tenant_id__get
GET/v1/usage/{tenant_id}/agentsGet Agent Usageget_agent_usage_v1_usage__tenant_id__agents_get
GET/v1/usage/{tenant_id}/chatGet Chat Usageget_chat_usage_v1_usage__tenant_id__chat_get
GET/v1/usage/{tenant_id}/llm-summaryLlm Usage Summaryllm_usage_summary_v1_usage__tenant_id__llm_summary_get
POST/v1/usage/{tenant_id}/recordRecord Usagerecord_usage_v1_usage__tenant_id__record_post
GET/v1/usage/{tenant_id}/summaryGet Usage Summaryget_usage_summary_v1_usage__tenant_id__summary_get
POST/v1/webhook/stripeStripe Webhookstripe_webhook_v1_webhook_stripe_post

​
llm-router-service

MethodPathTagsSummaryOperation ID
GET/healthHealthhealth_health_get
GET/v1V1 Rootv1_root_v1_get
POST/v1/chatChatchat_v1_chat_post
POST/v1/chat/completionsOpenai Chat Completionsopenai_chat_completions_v1_chat_completions_post
POST/v1/cost-estimateCost Estimatecost_estimate_v1_cost_estimate_post
POST/v1/messagesAnthropic Messagesanthropic_messages_v1_messages_post
GET/v1/modelsList Modelslist_models_v1_models_get
GET/v1/providers/healthProviders Healthproviders_health_v1_providers_health_get
GET/v1/usage/meGet My Usageget_my_usage_v1_usage_me_get
GET/v1/usage/me/quotaGet My Quotaget_my_quota_v1_usage_me_quota_get

​
mcp-router-service

MethodPathTagsSummaryOperation ID
GET/healthHealthhealth_health_get
POST/mcp/askAskask_mcp_ask_post
POST/mcp/executeExecuteexecute_mcp_execute_post
POST/mcp/planPlanplan_mcp_plan_post
GET/mcp/plansList Planslist_plans_mcp_plans_get
POST/mcp/routeRouteroute_mcp_route_post
GET/mcp/router/toolsList Routable Toolslist_routable_tools_mcp_router_tools_get
GET/mcp/serversList Serverslist_servers_mcp_servers_get
POST/mcp/serversUpsert Serverupsert_server_mcp_servers_post
GET/mcp/toolsList Routable Toolslist_routable_tools_mcp_tools_get
POST/v1/mcp/askAskask_v1_mcp_ask_post
POST/v1/mcp/executeExecuteexecute_v1_mcp_execute_post
POST/v1/mcp/planPlanplan_v1_mcp_plan_post
GET/v1/mcp/plansList Planslist_plans_v1_mcp_plans_get
POST/v1/mcp/routeRouteroute_v1_mcp_route_post
GET/v1/mcp/router/toolsList Routable Toolslist_routable_tools_v1_mcp_router_tools_get
GET/v1/mcp/serversList Serverslist_servers_v1_mcp_servers_get
POST/v1/mcp/serversUpsert Serverupsert_server_v1_mcp_servers_post

​
research-mcp-service

MethodPathTagsSummaryOperation ID
GET/healthHealthhealth_health_get
GET/readyReadyready_ready_get
GET/v1/research-mcp/toolsToolstools_v1_research_mcp_tools_get