> ## 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 provisioning job > `status`, `currentStep` and the failure `error`. Poll after any 202 until `status` is terminal. A run sitting at `await_oauth_install` is waiting on a workspace admin, not stuck — open its `installUrl` in a browser as one. That install starts a SECOND run and leaves this one parked, so follow the rest on the Worker. `installUrl` is a string only while an install is genuinely owed, and null the moment it is not. ## OpenAPI ````yaml /openapi.json get /api/v1/jobs/{id} 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/jobs/{id}: get: tags: - jobs summary: Get a provisioning job description: >- `status`, `currentStep` and the failure `error`. Poll after any 202 until `status` is terminal. A run sitting at `await_oauth_install` is waiting on a workspace admin, not stuck — open its `installUrl` in a browser as one. That install starts a SECOND run and leaves this one parked, so follow the rest on the Worker. `installUrl` is a string only while an install is genuinely owed, and null the moment it is not. operationId: getJob parameters: - name: id in: path required: true description: >- The provisioning job id, as returned by a 202. A malformed id answers 404, exactly as another organization's well-formed id does. schema: type: string description: >- The provisioning job id, as returned by a 202. A malformed id answers 404, exactly as another organization's well-formed id does. responses: '200': description: Success. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ProvisioningJob' required: - data additionalProperties: false example: data: id: 2f3e4d5c-6b7a-4980-8172-63544536271f status: pending currentStep: await_oauth_install error: null installUrl: >- https://slack.com/oauth/v2/authorize?client_id=1234567890123.9876543210987&scope=app_mentions%3Aread%2Cchannels%3Ahistory%2Cchat%3Awrite%2Cfiles%3Aread&redirect_uri=https%3A%2F%2Fcontrol.ergoly.ai%2Fapi%2Fslack%2Foauth%2Fcallback&state=b3BhcXVlLXNlYWxlZC1zdGF0ZQ startedAt: '2026-03-04T09:12:41.000Z' completedAt: null createdAt: '2026-03-04T09:12:38.000Z' '401': description: '`unauthorized`' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: '`not_found`' content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: '`rate_limited`' content: application/json: schema: $ref: '#/components/schemas/Error' security: - orgApiKey: - jobs:read components: schemas: ProvisioningJob: type: object description: One provisioning attempt on a Worker. properties: id: type: string description: The job id. Poll it at `GET /api/v1/jobs/{id}`. status: type: string description: >- `pending` | `running` | `succeeded` | `failed`. A run WAITING on the Slack install is `pending` at `currentStep: "await_oauth_install"` — `awaiting_install` is the WORKER's status, not a job's. currentStep: type: - string - 'null' description: The step the run is on, or stopped on. error: type: - string - 'null' description: Why the run failed. Null while it is healthy. installUrl: type: - string - 'null' description: >- Where a Slack workspace admin finishes the install. A string only while this run is stopped waiting for one — `currentStep` is `await_oauth_install` and the run has not settled. Null otherwise, including on a run that failed on that step. Open it in a browser as a workspace admin; the run then carries on by itself. startedAt: type: - string - 'null' format: date-time description: When the run began. completedAt: type: - string - 'null' format: date-time description: When it reached a terminal state. createdAt: type: string format: date-time description: When the job row was written. required: - id - status - currentStep - error - installUrl - startedAt - completedAt - createdAt 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.