# OpenSOP

> Define a process, get an API. Agents and humans interact through the same `/sop/*` endpoints.

OpenSOP is an open standard and runtime for defining business processes (SOPs) as YAML and exposing them as REST APIs. This file points crawlers and AI agents at the machine-readable documentation.

The full markdown bundle of every guide and endpoint lives at https://coba.opensop.ai/api-docs.md.

## Project

- **Source:** https://github.com/Chosen9115/opensop
- **Issues:** https://github.com/Chosen9115/opensop/issues
- **License:** [MIT](https://github.com/Chosen9115/opensop/blob/main/LICENSE)
- **API spec version:** 0.1

## Docs

- [Full bundle](https://coba.opensop.ai/api-docs.md): every guide and endpoint in one file.

## Guides

- [Quickstart](https://coba.opensop.ai/api-docs/guides/quickstart.md)
- [Authentication](https://coba.opensop.ai/api-docs/guides/authentication.md)
- [Process format](https://coba.opensop.ai/api-docs/guides/process-format.md)
- [Errors](https://coba.opensop.ai/api-docs/guides/errors.md)
- [Versioning](https://coba.opensop.ai/api-docs/guides/versioning.md)

## Endpoints


### Discovery

- [`GET /sop/`](https://coba.opensop.ai/api-docs/endpoints/list-processes.md): List all processes
- [`GET /sop/:name/schema`](https://coba.opensop.ai/api-docs/endpoints/process-schema.md): Get process schema

### Processes

- [`POST /sop/processes/register`](https://coba.opensop.ai/api-docs/endpoints/register-process.md): Register a process

### Instances

- [`GET /sop/instances`](https://coba.opensop.ai/api-docs/endpoints/list-instances.md): List all instances
- [`POST /sop/:name/start`](https://coba.opensop.ai/api-docs/endpoints/start-instance.md): Start an instance
- [`GET /sop/:name/:id`](https://coba.opensop.ai/api-docs/endpoints/show-instance.md): Get instance state
- [`POST /sop/:name/:id/cancel`](https://coba.opensop.ai/api-docs/endpoints/cancel-instance.md): Cancel an instance

### Steps

- [`GET /sop/:name/:id/steps`](https://coba.opensop.ai/api-docs/endpoints/list-steps.md): List steps
- [`POST /sop/:name/:id/steps/:step_id/submit`](https://coba.opensop.ai/api-docs/endpoints/submit-step.md): Submit a step
- [`GET /sop/steps/pending`](https://coba.opensop.ai/api-docs/endpoints/pending-steps.md): List pending steps

### Webhook triggers

- [`POST /sop/triggers/:process_name`](https://coba.opensop.ai/api-docs/endpoints/fire-trigger.md): Fire a trigger

### Webhook callbacks

- [`POST /sop/webhooks/:callback_id`](https://coba.opensop.ai/api-docs/endpoints/deliver-callback.md): Deliver a webhook callback

### Metrics

- [`GET /sop/metrics`](https://coba.opensop.ai/api-docs/endpoints/show-metrics.md): Get metrics