# Outworx API

**Canonical:** https://apis.io/apis/outworx/outworx-api/  
**Provider:** Outworx — https://apis.io/providers/outworx/  
**Documentation:** https://docs.outworx.io/api

Outworx API is published by [Outworx](https://apis.io/providers/outworx/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Outworx API as documented publicly: 27 operations. Contract generated from the documentation by API Evangelist (2026-10-18); not the provider's own document.

## Operations (27)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/feed/posts` | Types for listPosts — GET /api/feed/posts |
| GET | `/api/projects/acme/sdk` | GET /api/projects/acme/sdk |
| GET | `/api/v1/projects` | List your projects (paginated, ?q= filter) |
| POST | `/api/v1/projects` | Create a project — slug auto-generates from name |
| DELETE | `/api/v1/projects/{slug}` | Delete a project (cascades to versions) |
| GET | `/api/v1/projects/{slug}` | Get one project |
| PATCH | `/api/v1/projects/{slug}` | Sparse update: name, is_public, base_url, custom domain |
| GET | `/api/v1/projects/{slug}/versions` | List versions (?include_previews= to surface PR-scoped rows) |
| POST | `/api/v1/projects/{slug}/versions` | Push a spec version (?label=, ?makeDefault=, ?preview= for PR previews) |
| DELETE | `/api/v1/projects/{slug}/versions/{label}` | Delete a version (default version is protected) |
| GET | `/api/v1/projects/{slug}/versions/{label}` | Get one version |
| PATCH | `/api/v1/projects/{slug}/versions/{label}` | Promote default, soft-deactivate, override base_url |
| POST | `/checkout` | POST /checkout |
| GET | `/mock/acme/v1/users` | Mock endpoint for listing users |
| GET | `/orders` | GET /orders |
| POST | `/payment_intent.succeeded` | Webhooks playground |
| POST | `/pull_request.opened` | Webhooks playground |
| GET | `/users` | GET /users |
| POST | `/users` | POST /users |
| POST | `/v1/checkout/sessions` | Start checkout |
| GET | `/v1/orders/{orderid}` | Read order |
| GET | `/v1/users` | List users |
| POST | `/v1/users` | Create user |
| POST | `/v1/users/{id}/invites` | new endpoint |
| POST | `/v2/checkout` | New Create a checkout session with line items and an optional idempotency key. |
| POST | `/v2/users` | POST /v2/users |
| GET | `/v2/users/{id}` | GET /v2/users/{id} |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/outworx/refs/heads/main/openapi/_ae-authored/outworx-openapi-generated.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/outworx/refs/heads/main/json-schema/outworx-post-api-v1-projects-slug-versions-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/outworx/refs/heads/main/json-schema/outworx-patch-api-v1-projects-slug-versions-label-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/outworx/refs/heads/main/json-schema/outworx-get-api-v1-projects-slug-versions-label-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/outworx/refs/heads/main/json-schema/outworx-get-api-feed-posts-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/outworx/refs/heads/main/json-schema/outworx-get-mock-acme-v1-users-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/outworx/refs/heads/main/json-schema/outworx-patch-api-v1-projects-slug-versions-label-response-schema.json
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/outworx/refs/heads/main/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/outworx/outworx-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/outworx/.