# flow2act · Ask the docs

Ask implementation questions grounded in this reference. Sign in to use the assistant.

Only your question and public docs go to DeutschlandGPT. No workspace records, session tokens or API keys are supplied as context. Never include secrets or personal data. Known credential formats are blocked before sending. Answers are suggestions with sources, not executed commands.

AI is disabled by default per organization and environment. An administrator must explicitly enable external AI processing under Organization → Privacy. Never include credentials or confidential personal information. Local keyword search remains available with smart=false.

## POST /v1/ai/docs-questions

Authentication: FLOW2ACT_ACCESS_TOKEN from flow2act sign-in
Required tenant header: X-Organization-Id.
Required user permissions: Active workspace membership required. The API checks current membership, roles, key scopes and resource permissions on every request. Documentation visibility grants no access.

## Input parameters
- question (string, required): min length 5 · max length 2000
- topic (string, required): integrations | create-integration | update-integration | domains | add-domain | verify-domain | run-actions | retry-action | email-ingress | edit-flow | step-types | notifications | documents | document-upload | document-confirm | document-link | document-list | document-content | received-email | external-received-email | external-document-list | external-document-content | business-profile | save-business-profile | activate-live | webhooks | create-webhook | update-webhook | rotate-webhook-secret | webhook-deliveries | retry-webhook-delivery | external-resolve | external-decide | external-status | external-resend | sandbox-mailbox | service-accounts | create-service-account | update-service-account | sandbox-developers | set-sandbox-developer | postman | obtain-token | refresh-token | auth-challenge | register-account | confirm-account | workspace | workspaces | invite-user | invitations | retry-invitation | accept-sandbox-invitation | validate-user-import | create-user-import | get-user-import | retry-user-import | overview | sandbox | create-sandbox | authentication | idempotency | errors | list-flows | get-flow | create-flow | save-draft | publish-flow | start-run | list-runs | get-run | run-overview | history | approvals | decide | groups | link-group | update-group | directory | create-person | update-person | create-unit | update-unit | rename-workspace | responsibilities | api-keys | create-key | revoke-key | generate-flow | search-flows | ask-docs | limits
- locale (string, optional): en | de · default "en"

## Request example (replace example IDs)

```sh
curl -X POST "https://api.flow2act.com/v1/ai/docs-questions" \
  -H "authorization: Bearer $FLOW2ACT_ACCESS_TOKEN" \
  -H "x-organization-id: 10000000-0000-4000-8000-000000000001" \
  -H "content-type: application/json" \
  --data-raw '{
  "question": "How do I start a published flow safely?",
  "topic": "start-run",
  "locale": "en"
}'
```

## Response excerpt

```json
{
  "answer": "Use POST /v1/flow-runs with a published version ID and a stable Idempotency-Key.",
  "sources": [
    "start-run",
    "idempotency"
  ]
}
```

Source: /docs/ask-docs
Full schemas: /docs/openapi.json
