> ## Documentation Index > Fetch the complete documentation index at: https://docs.ergoly.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get a connect URL > A consent screen needs a browser and a person, so this returns a link to open rather than claiming to finish. The link carries a single-use nonce instead of an Ergoly session, which means it can be opened in a private window signed into whichever account should be connected — usually the reason you are doing this. It expires; build another if it goes stale. Nothing exists in the vault until consent completes, at which point the connection appears in the list. ## OpenAPI ````yaml /openapi.json post /api/v1/connections/oauth/{provider}/connect-url openapi: 3.1.0 info: title: Ergoly platform API version: 1.0.0 description: >- Read and change one organization's own Ergoly environment. Every route is scoped to the organization the presented credential resolves to; there is no parameter that widens it. The human-readable reference is served from the same namespace at `/api/v1/docs`, behind the same credential. The namespace's front door is `GET /api/v1`, and it is deliberately absent from `paths` below. It answers without a credential — what this API is, how an organization admin mints a key, and where the reference lives — so it is the way in to this contract rather than a part of it: it has no scope, takes no parameters, and there is nothing about it for a generated client to call. Every `unauthorized` refusal carries that same URL as `error.docs`. servers: - url: https://control.ergoly.ai security: - orgApiKey: [] tags: - name: auth description: How to present a key, what it is scoped to, and what a 401 means. - name: organization description: Which organization your credential resolves to. - name: workers description: The Slack apps and bot identities in your organization. - name: eworks description: The runtime instances under a Worker — one core, one per bound Client. - name: clients description: The customers a Worker can be scoped to, and how to bind one. - name: channels description: Which Slack rooms a Worker answers in, and who it answers as. - name: tasks description: >- Tasks handed between Workers and people, scheduled jobs, their targets, and their run history. - name: jobs description: How a provisioning run is going — the other half of every 202. - name: memory description: Read and write the memory tiers an ework mounts. - name: connections description: The credentials your agents use, and the hosts they are injected on. - name: webhooks description: Inbound URLs an outside system can POST to, each of which starts a turn. - name: activity description: Your organization's audit feed. - name: usage description: Cost, turn outcomes and a per-day pulse over a window you choose. - name: errors description: The closed set of refusal codes, and what to do about each. paths: /api/v1/connections/oauth/{provider}/connect-url: post: tags: - connections summary: Get a connect URL description: >- A consent screen needs a browser and a person, so this returns a link to open rather than claiming to finish. The link carries a single-use nonce instead of an Ergoly session, which means it can be opened in a private window signed into whichever account should be connected — usually the reason you are doing this. It expires; build another if it goes stale. Nothing exists in the vault until consent completes, at which point the connection appears in the list. operationId: createOAuthConnectUrl parameters: - name: provider in: path required: true description: >- The provider to connect, as named in Ergoly's provider registry. An unknown one is a 400. schema: type: string description: >- The provider to connect, as named in Ergoly's provider registry. An unknown one is a 400. - name: Idempotency-Key in: header required: false description: >- Any unique string. A retry under the same key is answered from the first attempt's record, with `X-Idempotent-Replay: true`. The same key with a different body is a conflict. schema: type: string description: Any unique string. requestBody: required: true content: application/json: schema: type: object properties: key: type: string description: The key the connected account will be stored under. scope: type: string enum: - org - worker - client description: >- Which identities will resolve the account. Defaults to `org`. workerId: type: string description: Required when `scope` is `worker`. clientId: type: string description: Required when `scope` is `client`. providerScopes: type: array items: type: string description: A provider OAuth scope. description: >- Extra provider scopes, unioned with the provider app's defaults. required: - key additionalProperties: false example: key: github_main scope: org providerScopes: - repo responses: '201': description: Success. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/OAuthConnectUrl' required: - data additionalProperties: false example: data: provider: github key: github_main scope: org workerId: null clientId: null authorizeUrl: >- https://github.com/login/oauth/authorize?client_id=Iv1.8a61f9b3a7aba766&redirect_uri=https%3A%2F%2Fcontrol.ergoly.ai%2Fapi%2Fauth%2Foauth%2Fgithub%2Fcallback&scope=repo+read%3Aorg&state=9f2c1b7d30a4b8a5 nextStep: >- Open authorizeUrl in a browser and complete the provider's consent screen. The connection appears in GET /api/v1/connections once consent finishes. '400': description: '`invalid_request`' content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: '`unauthorized`' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: '`not_found`' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: '`conflict`' content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: '`rate_limited`' content: application/json: schema: $ref: '#/components/schemas/Error' security: - orgApiKey: - connections:write components: schemas: OAuthConnectUrl: type: object properties: provider: type: string description: The provider being connected. key: type: string description: The key the account will be stored under once consent lands. scope: type: string enum: - org - worker - client description: The scope it will be stored at. workerId: type: - string - 'null' description: The Worker, when scoped to one. clientId: type: - string - 'null' description: The Client, when scoped to one. authorizeUrl: type: string description: >- Open this in a browser. Single-use and short-lived; build another if it goes stale. nextStep: type: string description: What a caller has to do next, in words. required: - provider - key - scope - workerId - clientId - authorizeUrl - nextStep additionalProperties: false Error: type: object description: The one error shape. Every refusal in this namespace has it. properties: error: type: object description: The refusal. properties: code: type: string enum: - unauthorized - not_found - invalid_request - conflict - quota_exceeded - rate_limited - upstream_error - gone description: The machine-stable half. Branch on this, never on `message`. message: type: string description: Prose for a human reading a terminal. docs: type: string description: >- Where to learn how to authenticate. Present on `unauthorized` and on nothing else — it is the one refusal a caller can reach with no credential at all, so it is the one that has to say where the way in is. required: - code - message additionalProperties: false required: - error additionalProperties: false securitySchemes: orgApiKey: type: http scheme: bearer description: >- An organization-scoped API key, minted in control under Settings → API keys. Every failure to authenticate answers one identical 401: "Provide a valid organization-scoped API key or an active session." Each operation names the one scope it is filed under, `:`, where the resource is the first path segment after `/api/v1/`; a key minted today carries all 22 of them. Scopes are RECORDED — on the key and on every audit row — and are not yet enforced: no request is refused for want of one. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.