ZynplexZPX Forgeby Zynplex
For agents.md

API

The API lives at https://zpxforge.com/api/v1. The full specification (OpenAPI) is at /api/v1/docs.

Authentication

Today the API uses the browser session (an httpOnly cookie). Requests that change data must come from the site itself (Origin header).

The CLI uses a personal token authorized in the browser for supported endpoints. Customers record decisions in their verified web sessions.

Endpoints

Method and pathWhat it does
GET /v1/healthPlatform health (database, Redis, worker)
GET /v1/meThe person, their companies and pending invitations
GET /v1/rolesAvailable roles
POST /v1/orgsRegister a company
GET /v1/orgs/{company}Company, your role and your permissions
GET /v1/orgs/{company}/membersMembers
PATCH /v1/orgs/{company}/members/{id}Change a member's role
POST /v1/orgs/{company}/invitationsInvite by email
GET /v1/orgs/{company}/projectsProjects
POST /v1/orgs/{company}/projectsCreate a project
PUT /v1/orgs/{company}/projects/{p}/roles/{id}A person's role within a project
GET /v1/orgs/{company}/githubGitHub installations and repos
POST /v1/orgs/{company}/projects/{p}/reposConnect a repo to the project
POST /v1/orgs/{company}/projects/{p}/repos/{id}/protectProtect develop and main
GET /v1/orgs/{company}/auditAudit log (admins only)

Errors

{ "detail": "Tu rol no permite esta acción", "code": "forbidden" }

Error messages are in Spanish for now; rely on code and the HTTP status.

HTTP statusMeaning
401You need to sign in
403No permission, inactive company or origin not allowed
404It does not exist or you do not belong to that company
409Conflict (for example, the last admin)
429Too many attempts