# NEXUS AI API

NEXUS AI exposes authenticated HTTP APIs for deployments and infrastructure. Public API metadata is available at [OpenAPI](/openapi.json).

## GPT-compatible API

The public GPT-compatible API base URL is:

```text
https://mcp.nexusai.run/api/gpt
```

The implemented routes include:

- `GET /providers`
- `GET /deployments`
- `POST /deploy`
- `POST /uploads/zip`
- `POST /deploy/source`
- `GET /deployments/{id}`
- `GET /deployments/{id}/logs`
- `DELETE /deployments/{id}`

All GPT-compatible API routes require a Bearer access token. Mutating and destructive operations require the corresponding access-token scope. Rate limits are enforced by the NEXUS API.

## Platform API

The main NEXUS API also exposes authenticated routes for:

- projects and project members;
- AI Builder sessions, files, sharing, sandbox, model, and GitHub integration;
- deployments, logs, health, container metrics, scaling, start/stop, redeploy, rollback, and custom domains;
- external database sources and database intelligence;
- deployment database services, backups, restores, and schedules;
- persistent volumes and S3-compatible buckets;
- managed databases and snapshots;
- secrets, usage, audit, support tickets, GitHub bindings, AI providers, organization settings, and access tokens.

The verified route catalog is included in [OpenAPI](/openapi.json). These routes are not proxied by this documentation service; use the NEXUS API origin and its authentication requirements.

## Safety

Do not assume a caller is trusted because it identifies as an AI agent. Validate the token, scope, resource ownership, and user authorization before every operational request.

## Related resources

- [OpenAPI](/openapi.json)
- [MCP](/docs/mcp.md)
- [Security](/docs/security.md)