> ## Documentation Index > Fetch the complete documentation index at: https://docs.flowra.dev/llms.txt > Use this file to discover all available pages before exploring further. # Create a new auth link session > Generates a one-time URL to start the OAuth flow. Send your end users to this URL so they can sign in with the provider (e.g. Google, Slack) and connect their account to your project. After they complete the flow, the account appears in the connected accounts list. ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/connected_accounts/link openapi: 3.0.0 info: title: Flowra API (API Key Endpoints) description: >- **Flowra** is an AI-powered platform for building agents, workflows, and integrations. ### Capabilities - **Tools & Toolkits** – Define and group tools for agents and workflows. - **Workflows** – Orchestrate steps and automate processes. - **Triggers** – Schedule or event-based execution. - **Auth & Connections** – OAuth, API keys, and connected accounts. - **MCP** – Model Context Protocol server integration. - **Knowledge / RAG** – Add files and URLs for retrieval-augmented generation. ### Authentication Use the **x-api-key** header with a project API key to access endpoints that support API Key auth. Create and manage API keys in the dashboard under your project settings. Only endpoints that support API Key authentication via the @ApiKeyEnabled() decorator. Send x-api-key (required). On multi-tenant endpoints, optionally send x-username to act as an external user. version: '1.0' contact: name: Flowra url: https://flowra.dev servers: - url: https://flowra.dev description: Flowra API security: [] tags: - name: Users description: User profile - name: External Users description: End-user identities inside a project (x-username) - name: Auth Configs description: OAuth and API key configs for toolkits - name: Connected Accounts description: OAuth connected accounts and link creation - name: Toolkits description: List and search toolkits - name: Tools description: List, execute, and manage tools - name: Skills description: Browse, create, import, and install skills - name: Workflow & Agent description: Create, run, and inspect workflows and agents - name: Triggers description: Schedule and event-based trigger instances - name: Chat description: Threads and streaming agent runs - name: File description: Upload, list, and download files - name: Knowledge description: RAG knowledge collections - name: Table description: Collections and documents - name: Sandbox description: Ephemeral and durable code sandboxes - name: Browser description: Live browser sessions and view - name: LLM description: List AI models and generate completions - name: MCP description: MCP server management - name: usage description: Credit balance and usage ledger for the project API key paths: /api/v1/connected_accounts/link: post: tags: - Connected Accounts summary: Create a new auth link session description: >- Generates a one-time URL to start the OAuth flow. Send your end users to this URL so they can sign in with the provider (e.g. Google, Slack) and connect their account to your project. After they complete the flow, the account appears in the connected accounts list. operationId: ConnectedAccountsController_createConnectedAccountLink parameters: - name: x-username in: header required: false description: >- External user (end user) to act as. Optional — if omitted, Flowra uses the project’s default external user. Send a stable username (e.g. customer_alice) only when you need another end-user context. schema: type: string default: (project default user) example: customer_alice requestBody: required: true description: Connected account link creation data content: application/json: schema: $ref: '#/components/schemas/CreateConnectedAccountLinkDto' responses: '201': description: Successfully created auth link content: application/json: schema: $ref: >- #/components/schemas/CreateConnectedAccountLinkResponseDtoSuccessResponse security: - x-api-key: [] - x-api-key: [] x-username: [] components: schemas: CreateConnectedAccountLinkDto: type: object properties: authConfigId: type: string description: Auth configuration ID example: auth_config_123 callbackUrl: type: string description: Callback URL example: https://myapp.com/callback connectionData: $ref: '#/components/schemas/ConnectedAccountConnectionValDto' required: - authConfigId CreateConnectedAccountLinkResponseDtoSuccessResponse: type: object properties: success: type: boolean description: Success status example: true message: type: string description: Success message example: Operation completed successfully data: type: object properties: linkToken: type: string description: Link token for authentication example: link_token_123456789 redirectUrl: type: string description: Redirect URL for user authentication example: >- https://auth.composio.dev/oauth/authorize?client_id=123&redirectUri=https://myapp.com/callback expiresAt: type: string description: Expiration timestamp for the link example: '2024-12-31T23:59:59Z' connectedAccountId: type: string description: Connected account ID example: con_123456789 required: - redirectUrl example: linkToken: link_token_123456789 redirectUrl: >- https://auth.composio.dev/oauth/authorize?client_id=123&redirectUri=https://myapp.com/callback expiresAt: '2024-12-31T23:59:59Z' connectedAccountId: con_123456789 required: - success - message - data ConnectedAccountConnectionValDto: type: object properties: cookies: type: string description: Full Cookie header for authenticated requests localStorage: type: object description: Subset of localStorage used for captured session additionalProperties: type: string localStorageHeaderBindings: type: array items: $ref: '#/components/schemas/LocalStorageHeaderBindingDto' access_token: type: string example: ya29.a0AfH6SMC... account_id: type: string accountId: type: string description: Zernio / partner social account id (camelCase) profileId: type: string description: Zernio multi-tenant profile id platform: type: string description: Partner platform slug, e.g. instagram account_url: type: string api_key: type: string api_url: type: string application_id: type: string authed_user: $ref: '#/components/schemas/ComposioCustomConnectionAuthedUserDto' authUri: type: string description: Authorization / OAuth URI base_url: type: string basic_encoded: type: string bearer_token: type: string borneo_dashboard_url: type: string callbackUrl: type: string description: Callback URL (camelCase variant) callback_url: type: string client_id: type: string COMPANYDOMAIN: type: string description: Composio COMPANYDOMAIN composio_link_redirect_url: type: string consumer_key: type: string code_verifier: type: string description: PKCE / OAuth code verifier credentials_json: type: string description: Opaque credentials JSON string dc: type: string dev_key: type: string description: Flowra / toolkit dev key domain: type: string error: type: string error_description: type: string expired_at: type: string expires_in: type: object example: 3600 extension: type: string final_redirect_uri: type: string description: Final redirect after OAuth form_api_base_url: type: string generic_api_key: type: string id_token: type: string instanceEndpoint: type: string instanceName: type: string installation_id: type: string long_redirect_url: type: boolean oauth_token: type: string oauth_token_secret: type: string oauth_verifier: type: string password: type: string private_key: type: string proxy_password: type: string proxy_username: type: string redirectUrl: type: string refresh_token: type: string registration_access_token: type: string registration_client_uri: type: string region: type: string scope: type: object example: - read - write server_location: type: string shop: type: string site_name: type: string status: enum: - INITIALIZING - INITIATED - ACTIVE - FAILED - EXPIRED - INACTIVE type: string example: INITIATED state_prefix: type: string subdomain: type: string token: type: string token_type: type: string username: type: string version: type: string webhook_signature: type: string your-domain: type: string your_server: type: string LocalStorageHeaderBindingDto: type: object properties: headerName: type: string example: Authorization localStorageKey: type: string example: token headerValue: type: string example: Bearer … required: - headerName - localStorageKey - headerValue ComposioCustomConnectionAuthedUserDto: type: object properties: access_token: type: string example: ya29.a0AfH6SMC... scope: type: string example: read,write securitySchemes: x-api-key: type: apiKey in: header name: x-api-key description: >- Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key: x-username: type: apiKey in: header name: x-username description: >- Optional. External user username. If omitted, Flowra uses the project’s default external user. Send as header: x-username: ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.