> For the complete documentation index, see [llms.txt](https://docs.controlbee.nl/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.controlbee.nl/api/processes.md).

# Processes

API endpoints for retrieving process information and importing process descriptions

## GET /api/processes

> List processes

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"tags":[{"name":"Processes","description":"API endpoints for retrieving process information and importing process descriptions"}],"servers":[{"url":"https://{organisation}.controlbee.nl","description":"Your organisation's ControlBee environment","variables":{"organisation":{"default":"your-organisation","description":"The name in the address you use to log in to ControlBee"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Create an API token in ControlBee: click your profile picture, choose **Company management** and add a token under **API tokens** on the **General** page. Only users who are allowed to manage the company see this option. See [General and API](https://docs.controlbee.nl/en/profiel/bedrijfsbeheer/algemeen-en-api) in the manual. Send the token as `Authorization: Bearer <token>`."}},"schemas":{"Process":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["draft","published"],"description":"Whether the returned description reflects a pending draft or the published version. An imported description lands in a draft, so the response reports 'draft' until the draft is published."},"description":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"string"}}}},"responses":{"UnauthorizedResponse":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"ForbiddenErrorResponse":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"NotFoundResponse":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"MethodNotAllowedResponse":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"InternalServerErrorResponse":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"paths":{"/api/processes":{"get":{"summary":"List processes","operationId":"getProcesses","tags":["Processes"],"responses":{"200":{"description":"Successful processes response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Process"}}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"403":{"$ref":"#/components/responses/ForbiddenErrorResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"405":{"$ref":"#/components/responses/MethodNotAllowedResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorResponse"}}}}}}
```

## Upload a process image

> Uploads an image for use in a process description. Because inline base64 (data:) image sources are stripped when a description is imported, an image has to be uploaded here first; the returned 'url' can then be used as the 'src' of an image in the description you send to 'PUT /api/processes/{processId}/description'. Uploaded images are stored per company and are only served to users of that company.

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"tags":[{"name":"Processes","description":"API endpoints for retrieving process information and importing process descriptions"}],"servers":[{"url":"https://{organisation}.controlbee.nl","description":"Your organisation's ControlBee environment","variables":{"organisation":{"default":"your-organisation","description":"The name in the address you use to log in to ControlBee"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Create an API token in ControlBee: click your profile picture, choose **Company management** and add a token under **API tokens** on the **General** page. Only users who are allowed to manage the company see this option. See [General and API](https://docs.controlbee.nl/en/profiel/bedrijfsbeheer/algemeen-en-api) in the manual. Send the token as `Authorization: Bearer <token>`."}},"schemas":{"ImageUploadRequest":{"type":"object","required":["upload"],"properties":{"upload":{"type":"string","format":"binary","description":"The image to upload, sent as multipart/form-data. Accepted formats are jpeg, png, gif, bmp and webp; SVG is not accepted. The file may not be larger than 4096 kilobytes. The image is stored at a maximum width of 2048 pixels and a thumbnail of 300 pixels wide is generated alongside it."}}},"ImageUpload":{"type":"object","properties":{"url":{"type":"string","description":"The path the stored image is served from, relative to the tenant domain. Use this value as the 'src' of an image in content you send to ControlBee. The file name is generated on upload; the name of the uploaded file is not preserved."},"width":{"type":"integer","description":"The width of the stored image in pixels, after resizing."},"height":{"type":"integer","description":"The height of the stored image in pixels, after resizing."},"message":{"type":"string"}}}},"responses":{"UnauthorizedResponse":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"ForbiddenErrorResponse":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"MethodNotAllowedResponse":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"ValidationErrorResponse":{"description":"Unprocessable content. The request did not pass validation.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","description":"The validation messages per field.","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}},"InternalServerErrorResponse":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"paths":{"/api/processes/upload":{"post":{"summary":"Upload a process image","description":"Uploads an image for use in a process description. Because inline base64 (data:) image sources are stripped when a description is imported, an image has to be uploaded here first; the returned 'url' can then be used as the 'src' of an image in the description you send to 'PUT /api/processes/{processId}/description'. Uploaded images are stored per company and are only served to users of that company.","operationId":"uploadProcessImage","tags":["Processes"],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}}},"responses":{"200":{"description":"The image was stored. The 'url' is the path the image is served from.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUpload"}}}},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"403":{"$ref":"#/components/responses/ForbiddenErrorResponse"},"405":{"$ref":"#/components/responses/MethodNotAllowedResponse"},"422":{"$ref":"#/components/responses/ValidationErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorResponse"}}}}}}
```

## Import a process description

> Imports a process description. The imported content lands in a draft version; the published process description stays unchanged until the draft is published. The response reflects the draft: its 'status' is 'draft' and its 'description' contains the just-imported content, so an integration can validate that the import landed correctly.

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"tags":[{"name":"Processes","description":"API endpoints for retrieving process information and importing process descriptions"}],"servers":[{"url":"https://{organisation}.controlbee.nl","description":"Your organisation's ControlBee environment","variables":{"organisation":{"default":"your-organisation","description":"The name in the address you use to log in to ControlBee"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Create an API token in ControlBee: click your profile picture, choose **Company management** and add a token under **API tokens** on the **General** page. Only users who are allowed to manage the company see this option. See [General and API](https://docs.controlbee.nl/en/profiel/bedrijfsbeheer/algemeen-en-api) in the manual. Send the token as `Authorization: Bearer <token>`."}},"schemas":{"UpdateDescription":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"The process description to import. You may supply either HTML or Markdown; use the X-Content-Format header to declare which (defaults to HTML). Markdown is converted to HTML on import. In both cases the result is sanitised before it is stored: only a safe subset of HTML is kept (headings, paragraphs, lists, tables, links, images, basic text formatting), scripts and event handlers are stripped, and inline base64 (data:) image sources are removed - so images must be referenced by a URL."}}},"Process":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["draft","published"],"description":"Whether the returned description reflects a pending draft or the published version. An imported description lands in a draft, so the response reports 'draft' until the draft is published."},"description":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"string"}}}},"responses":{"UnauthorizedResponse":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"ForbiddenErrorResponse":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"NotFoundResponse":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"ValidationErrorResponse":{"description":"Unprocessable content. The request did not pass validation.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","description":"The validation messages per field.","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}},"InternalServerErrorResponse":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"paths":{"/api/processes/{processId}/description":{"put":{"summary":"Import a process description","description":"Imports a process description. The imported content lands in a draft version; the published process description stays unchanged until the draft is published. The response reflects the draft: its 'status' is 'draft' and its 'description' contains the just-imported content, so an integration can validate that the import landed correctly.","operationId":"updateProcessDescription","tags":["Processes"],"parameters":[{"name":"processId","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier of the process."},{"name":"X-Content-Format","in":"header","required":false,"schema":{"type":"string","enum":["html","markdown"],"default":"html"},"description":"Declares how the 'description' in the body is interpreted. Use 'html' to send an HTML string (the default when the header is omitted), or 'markdown' to send Markdown, which is converted to HTML on import. Any other value is treated as 'html'. Regardless of format the stored result is sanitised."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDescription"}}}},"responses":{"200":{"description":"The imported description was stored as a draft. The returned process reflects that draft: 'status' is 'draft' and 'description' holds the imported content.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Process"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"403":{"$ref":"#/components/responses/ForbiddenErrorResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/ValidationErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorResponse"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.controlbee.nl/api/processes.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.