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

# Scribe

Inspect Scribe's provider-session and artifact HTTP contracts using operation blocks rendered from its separate public OpenAPI schema.

Scribe has a separate API host and provider-principal access model. Use the base assigned to your deployment and the scope required by the operation. The public schema linked here is the US contract; its availability does not establish enrollment or deployment in another region.

Start with [Capture to Finalized Note](https://docs.concurrence.com/developer-guide/guides/scribe-capture-to-note) for the workflow and [Scribe authentication](https://docs.concurrence.com/developer-guide/platform-api/scribe#authentication) for provider access. [Sessions](https://docs.concurrence.com/developer-guide/platform-api/scribe/sessions) and [Artifacts](https://docs.concurrence.com/developer-guide/platform-api/scribe/artifacts) explain lifecycle and recovery semantics.

The operation blocks below render the canonical request and response contracts. Health and readiness probes are excluded from this customer reference. The Zoom OAuth callback is a redirect target for the authorization flow, not an operation to call directly.

[Download the Scribe OpenAPI schema](https://scribe.platform.amigo.ai/v1/openapi.json).

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/appointments" method="get" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/appointments/{appointment\_id}" method="get" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/provider/settings" method="get" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/provider/settings" method="put" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions" method="get" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}" method="get" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}" method="patch" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/actions" method="get" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/actions" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/allocate" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/ask" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/cancel" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/checklist" method="get" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/checklist" method="patch" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/checklist/auto-check" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/codes" method="get" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/codes" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/codes/manual" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/codes/{suggestion\_id}" method="patch" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/end" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/events" method="get" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/note" method="get" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/note" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/note" method="put" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/note/finalize" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/note/regenerate-section" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/summary" method="get" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/summary" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/ticket" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/transcript" method="get" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/zoom" method="delete" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/zoom/pause" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/sessions/{session\_id}/zoom/resume" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/zoom/connection" method="delete" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/zoom/connection" method="get" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/zoom/oauth/authorize" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/zoom/oauth/callback" method="get" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}

{% openapi src="<https://scribe.platform.amigo.ai/v1/openapi.json>" path="/v1/{workspace\_id}/zoom/sessions" method="post" %}
<https://scribe.platform.amigo.ai/v1/openapi.json>
{% endopenapi %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.concurrence.com/api-reference/readme/scribe.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.