> ## Documentation Index > Fetch the complete documentation index at: https://docs.omnara.com/llms.txt > Use this file to discover all available pages before exploring further. # Get machine pool ## OpenAPI ````yaml /api-reference/openapi.yaml get /orgs/{orgID}/machine-pools/{poolID} openapi: 3.1.2 info: title: Omnara API version: 0.1.0 description: Public HTTP API contract for Omnara. servers: - url: https://api.omnara.com/v1 description: Hosted Omnara security: - bearerAuth: [] - browserSessionCookie: [] tags: - name: Agents description: >- Launch agents, send inputs, manage the input backlog, and work with tool calls. externalDocs: description: Guide url: https://docs.omnara.com/agents/overview - name: Interactions description: List and resolve the approvals and questions that pause an agent. externalDocs: description: Guide url: https://docs.omnara.com/events/interactions - name: Actors description: Attribute agent inputs and interaction responses to external users. externalDocs: description: Guide url: >- https://docs.omnara.com/events/sending-input#who-said-that-actors-and-attribution - name: Events description: Read or stream the agent timeline, list turns, and download artifacts. externalDocs: description: Guide url: https://docs.omnara.com/events/streaming - name: Configs and Profiles description: >- Create agent configs, manage reusable launch profiles, and set up integrations. externalDocs: description: Guide url: https://docs.omnara.com/agents/configuration - name: Models description: Configure model providers and models, and grant projects access to them. externalDocs: description: Guide url: https://docs.omnara.com/organization/model-providers - name: Machines description: Register machines, control project access, and manage daemon tokens. externalDocs: description: Guide url: https://docs.omnara.com/machines/connect - name: Machine Pools description: Define machine pools and grant projects access to them. externalDocs: description: Guide url: https://docs.omnara.com/machines/pools - name: Secrets description: >- Manage secret ownership and versions, and inspect or grant project availability. externalDocs: description: Guide url: https://docs.omnara.com/organization/secrets - name: Skills description: Manage versioned skill ownership and load skill instructions on demand. externalDocs: description: Guide url: https://docs.omnara.com/tools/skills - name: Organizations and Projects description: Create organizations and projects and manage membership. externalDocs: description: Guide url: https://docs.omnara.com/organization/members - name: Users and API Keys description: >- The authenticated user, personal and organization API keys, and invitations. externalDocs: description: Guide url: https://docs.omnara.com/api/authentication - name: Machine Daemon description: Routes the Omnara machine daemon uses to connect a machine. paths: /orgs/{orgID}/machine-pools/{poolID}: parameters: - name: orgID in: path required: true schema: type: string pattern: ^org_[a-z2-7]{26}$ - name: poolID in: path required: true schema: type: string pattern: ^mpo_[a-z2-7]{26}$ get: tags: - Machine Pools summary: Get machine pool operationId: getMachinePool responses: '200': description: Machine pool. content: application/json: schema: $ref: '#/components/schemas/MachinePool' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '503': $ref: '#/components/responses/ServiceUnavailable' 4XX: $ref: '#/components/responses/ClientError' 5XX: $ref: '#/components/responses/ServerError' components: schemas: MachinePool: type: object additionalProperties: false required: - id - org_id - name - management_kind - description - provider - default_machine_cpu - default_machine_memory_mb - default_machine_env - default_machine_secret_env - default_machine_provider_options - default_cwd - provider_config - runtime_protection_enabled - max_total_machines - max_total_cpu - max_total_memory_mb - min_machine_cpu - min_machine_memory_mb - max_machine_cpu - max_machine_memory_mb - delete_after_idle_minutes - metadata - created_at - updated_at properties: id: $ref: '#/components/schemas/MachinePoolID' org_id: $ref: '#/components/schemas/OrganizationID' name: $ref: '#/components/schemas/ResourceName' management_kind: $ref: '#/components/schemas/ManagementKind' description: type: string provider: type: string default_machine_cpu: type: - integer - 'null' format: int32 minimum: 1 maximum: 2147483647 default_machine_memory_mb: type: - integer - 'null' format: int32 minimum: 1 maximum: 2147483647 default_machine_env: description: >- Default environment for pool machines. A machine's environment, including resolved secret_env values, is applied to the provider machine at provisioning, so the provider_options startup_script and the daemon run with it, and is resolved again for each process at launch. type: object additionalProperties: type: string default_machine_secret_env: description: >- Default secret environment for pool machines, mapping env names to generic secret references. References are resolved to secret values wherever the machine environment is applied. type: object additionalProperties: $ref: '#/components/schemas/SecretID' default_machine_provider_options: type: object additionalProperties: true default_cwd: type: string provider_auth_secret_id: $ref: '#/components/schemas/SecretID' provider_config: type: object additionalProperties: true runtime_protection_enabled: description: >- Whether Omnara deletes this pool's machines when the provider remains running after the daemon becomes inactive. type: boolean max_total_machines: type: integer format: int32 minimum: 0 maximum: 2147483647 max_total_cpu: type: - integer - 'null' format: int32 minimum: 0 maximum: 2147483647 max_total_memory_mb: type: - integer - 'null' format: int32 minimum: 0 maximum: 2147483647 min_machine_cpu: type: - integer - 'null' format: int32 minimum: 0 maximum: 2147483647 min_machine_memory_mb: type: - integer - 'null' format: int32 minimum: 0 maximum: 2147483647 max_machine_cpu: type: - integer - 'null' format: int32 minimum: 1 maximum: 2147483647 max_machine_memory_mb: type: - integer - 'null' format: int32 minimum: 1 maximum: 2147483647 delete_after_idle_minutes: description: >- Idle minutes before deleting a machine from this pool, or null when the pool default is unset. type: - integer - 'null' format: int32 minimum: 5 maximum: 2147483647 metadata: $ref: '#/components/schemas/Metadata' created_at: $ref: '#/components/schemas/Timestamp' updated_at: $ref: '#/components/schemas/Timestamp' usage: $ref: '#/components/schemas/MachinePoolUsage' description: >- Current quota-consuming usage. Populated when the machine pool is returned by the list endpoint. MachinePoolID: type: string pattern: ^mpo_[a-z2-7]{26}$ OrganizationID: type: string pattern: ^org_[a-z2-7]{26}$ ResourceName: type: string minLength: 1 maxLength: 64 x-omnara-unicode-normalization: NFC description: >- Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not. ManagementKind: type: string description: >- Lifecycle owner. Tenant-managed resources can be changed through tenant APIs. Cluster-managed resources are installed and lifecycle-managed by the control plane; individual APIs may explicitly expose tenant-editable settings. enum: - tenant - cluster SecretID: type: string pattern: ^sec_[a-z2-7]{26}$ Metadata: type: object description: >- Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters. x-go-type: resourcemeta.Metadata x-go-type-import: path: github.com/omnara-ai/omnara/internal/resourcemeta x-go-type-skip-optional-pointer: true maxProperties: 16 propertyNames: minLength: 1 maxLength: 64 additionalProperties: type: string maxLength: 512 Timestamp: type: string format: date-time MachinePoolUsage: type: object additionalProperties: false required: - machines - cpu - memory_mb properties: machines: type: integer format: int32 minimum: 0 cpu: type: integer format: int64 minimum: 0 memory_mb: type: integer format: int64 minimum: 0 Error: type: object additionalProperties: false required: - error - code properties: error: type: string description: Human-readable error message. Do not match on it programmatically. code: type: string description: Stable error code for programmatic handling. enum: - invalid_request - unauthorized - forbidden - not_found - conflict - gone - request_too_large - unsupported_media_type - unprocessable - rate_limited - internal_error - upstream_error - service_unavailable - idempotency_key_conflict - state_transition_conflict - managed_work_admission_denied - pending_work - not_wake_capable - daemon_runtime_unregistered - validation_failed - csrf_check_failed - authentication_unavailable ClientErrorCode: type: string description: >- Stable error code carried by 4XX statuses. Subset of the Error code enum whose statuses are client errors. enum: - invalid_request - validation_failed - unauthorized - forbidden - csrf_check_failed - not_found - conflict - idempotency_key_conflict - state_transition_conflict - pending_work - not_wake_capable - gone - daemon_runtime_unregistered - request_too_large - unsupported_media_type - unprocessable - rate_limited ServerErrorCode: type: string description: >- Stable error code carried by 5XX statuses. Subset of the Error code enum whose statuses are server errors. enum: - internal_error - upstream_error - service_unavailable - authentication_unavailable responses: BadRequest: description: The request was invalid. content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Authentication is required or invalid. content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: The authenticated principal is not authorized. content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: The requested resource was not found or is not visible. content: application/json: schema: $ref: '#/components/schemas/Error' Conflict: description: >- The request conflicts with current resource state or idempotency history. content: application/json: schema: $ref: '#/components/schemas/Error' ServiceUnavailable: description: The service dependency required to satisfy the request is unavailable. content: application/json: schema: $ref: '#/components/schemas/Error' ClientError: description: >- Any other client error. The body carries the shared Error envelope restricted to client error codes; statuses with a dedicated response above are documented precisely. content: application/json: schema: type: object additionalProperties: false required: - error - code properties: error: type: string description: >- Human-readable error message. Do not match on it programmatically. code: $ref: '#/components/schemas/ClientErrorCode' ServerError: description: >- Any other server error. The body carries the shared Error envelope restricted to server error codes. content: application/json: schema: type: object additionalProperties: false required: - error - code properties: error: type: string description: >- Human-readable error message. Do not match on it programmatically. code: $ref: '#/components/schemas/ServerErrorCode' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: Omnara personal or organization access token description: An opaque Omnara personal or organization bearer token. browserSessionCookie: type: apiKey in: cookie name: __Host-omnara_session description: >- Browser session cookie. HTTPS deployments use __Host-omnara_session; local HTTP development uses omnara_session. ````