---
title: "Start documentation flow"
method: POST
path: "/catalog/v1/documentation-flow/start"
tags: ["Documentation Flow"]
---

# Start documentation flow

`POST /catalog/v1/documentation-flow/start`

## Request

- Base URL: `https://your-environment.ataccama.one/api`
- URL: `https://your-environment.ataccama.one/api/catalog/v1/documentation-flow/start`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/docs/catalog/v1/documentation-flow/start/post.ts> (a function with typed inputs; its response is checked against the schema)

Start a documentation flow asynchronously with a given configuration on a connection.

The request is accepted for processing and returns a link that identifies the running flow.

To run the flow on part of the connection only, use the `paths` field.

Returns `404 Not Found` when the configuration or connection doesn't exist.

## Request body

- object
  - `configurationUrn` string, uri, required: A URN identifying a documentation flow configuration resource in the Catalog API. Format: urn:ata:{tenant}:catalog:documentation-flow-configuration:{uuid} Example: urn:ata:acme-corp:catalog:documentation-flow-configuration:123e4567-e89b-12d3-a456-426614174000.
  - `connectionUrn` string, uri, required: A URN identifying a resource in any realm of the Public API. URNs follow RFC 8141. Format: urn:ata:{tenant}:{realm}:{resource-type}:{uuid} Components: - `urn` — fixed scheme - `ata` — Ataccama namespace - `{tenant}` — tenant identifier from the authentication context - `{realm}` — API realm, for example `catalog` or `reference-data` - `{resource-type}` — resource type within the realm, for example `catalog-item` or `table` - `{uuid}` — UUID (v4 or v7) of the resource Example: urn:ata:acme-corp:reference-data:table:123e4567-e89b-12d3-a456-426614174000.
  - `paths` string[]: List of paths to run the documentation flow on. When omitted, the flow runs on the whole connection.

## Response `202`

Documentation flow accepted for asynchronous processing. Poll the link from the Location header or response body (`polling.href`) for the state of the documentation flow workflow in the Processing Center.

- LongOperationResponse: Response returned when starting a long-running (asynchronous) operation.
  - `polling` HttpsLink, required: A base type of objects representing links to resources.
    - `href` string, uri, required: Any URI that is using HTTPS protocol. Use full, absolute URIs.
  - `result` HttpsLink: A base type of objects representing links to resources.
    - `href` string, uri, required: Any URI that is using HTTPS protocol. Use full, absolute URIs.

## Other responses

- `400`: Bad request. The request parameters or body are invalid.
- `403`: Forbidden. You do not have permission to access the requested resource.
- `404`: Not found. The requested resource does not exist.

---

[API](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api.md) - [All operations](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/revisions/46f16e0487f8?raw)