> ## Documentation Index > Fetch the complete documentation index at: https://docs.ns.rocks/llms.txt > Use this file to discover all available pages before exploring further. # Create an agent service instance > Persist a starting service instance. Runtime execution and URL materialization are handled by later runtime tickets. ## OpenAPI ````yaml /openapi.yaml post /v1/agent-deployments/{deployment_id}/services openapi: 3.1.0 info: title: Nullspace API version: 0.1.0 description: | Cloud machine platform for AI agents. Create on-demand microVMs, execute commands, manage files, automate desktop environments, and stream output over WebSocket. license: name: Apache-2.0 url: https://www.apache.org/licenses/LICENSE-2.0 servers: - url: https://api.13-215-85-171.sslip.io description: Private beta - url: https://nullspace.example description: Self-hosted single-host owned-domain - url: http://localhost description: Self-hosted single-host localhost/no-domain via Caddy - url: http://localhost:3000 description: Local development direct API security: - bearerAuth: [] tags: - name: Health description: Public process-liveness check (no auth required) - name: Machines description: Machine lifecycle, execution, and process management - name: Files description: Filesystem operations within a machine - name: Git description: First-class structured git operations within a machine - name: Desktop description: Desktop automation (mouse, keyboard, screenshots) - name: Recording description: Screen recording management - name: PTY description: Pseudo-terminal session management - name: Templates description: Machine template management - name: Agent Deployments description: Named, versioned agent deployment control plane - name: Volumes description: Persistent volume control plane and attached volume actions - name: WebSocket description: Streaming execution and PTY over WebSocket - name: Monitor description: In-repo WebSocket stream for machine health, metrics, and process updates - name: API Keys description: Runtime API key metadata and dormant self-serve key management - name: Account description: Dormant Supabase-session account profile, export, and deletion routes - name: Admin description: Supabase-session operator console APIs for account support - name: Auth description: Dormant self-serve Auth proxy routes gated by deployment config - name: Code description: Stateful code execution via Jupyter kernels (Code Interpreter) - name: Internal Operations description: Operator-only internal API surfaces; not part of the public SDK contract paths: /v1/agent-deployments/{deployment_id}/services: parameters: - $ref: '#/components/parameters/AgentDeploymentId' post: tags: - Agent Deployments summary: Create an agent service instance description: >- Persist a starting service instance. Runtime execution and URL materialization are handled by later runtime tickets. operationId: createAgentServiceInstance parameters: - $ref: '#/components/parameters/IdempotencyKeyHeader' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAgentServiceInstanceRequest' responses: '201': description: Agent service instance created content: application/json: schema: $ref: '#/components/schemas/AgentServiceInstance' '400': $ref: '#/components/responses/InvalidRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/AgentDeploymentNotFound' '409': $ref: '#/components/responses/AgentDeploymentConflict' '429': $ref: '#/components/responses/RateLimited' '503': $ref: '#/components/responses/FeatureUnavailable' components: parameters: AgentDeploymentId: name: deployment_id in: path required: true schema: type: string description: Agent deployment ID IdempotencyKeyHeader: name: Idempotency-Key in: header required: true schema: type: string description: >- Reuse the same key to safely retry the same create, reusable snapshot create, fork, upload create/complete, or agent deployment create operation without duplicating work. schemas: CreateAgentServiceInstanceRequest: type: object properties: version_id: type: string nullable: true envs: $ref: '#/components/schemas/AgentRuntimeEnvValues' AgentServiceInstance: type: object required: - id - deployment_id - version_id - status - port - created_at - updated_at properties: id: type: string example: adsvc_1234abcd deployment_id: type: string version_id: type: string status: $ref: '#/components/schemas/AgentServiceStatus' machine_id: type: string nullable: true process_id: type: integer format: uint32 nullable: true port: type: integer minimum: 1 maximum: 65535 public_url: type: string format: uri nullable: true description: >- Dynamic public URL for the ready service. Signed edge URLs contain bearer credentials such as `edge_token`; do not log or persist them. A null value means the service is not ready, has no backing machine, or `permissions.public_url` is disabled. readiness_status: type: object additionalProperties: true nullable: true description: >- Server-recorded readiness/lifecycle status detail for the service instance. Key set varies by lifecycle phase; deliberately open. failure_reason: type: string nullable: true started_at: type: string format: date-time nullable: true stopped_at: type: string format: date-time nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time idempotency_key: type: string nullable: true AgentRuntimeEnvValues: type: object additionalProperties: type: string writeOnly: true description: >- Request-only runtime environment variable values. P0 accepts string values only; future secret references are reserved by AgentSecretReference. Values are injected into agent processes and are not stored in deployment config, run, service, or platform event records. AgentServiceStatus: type: string enum: - starting - ready - unhealthy - stopping - stopped - failed ErrorResponse: type: object required: - error - code properties: error: type: string description: Human-readable error message code: type: string description: Machine-readable error code enum: - invalid_request - machine_not_found - snapshot_not_found - template_not_found - template_build_not_found - template_name_claim_not_found - machine_not_ready - unauthorized - auth_failed - auth_locked - auth_proxy_error - auth_proxy_unavailable - invalid_auth_redirect - invalid_oauth_provider - captcha_required - captcha_failed - captcha_unavailable - disposable_email - signup_rate_limited - oauth_rate_limited - email_action_rate_limited - database_error - email_not_verified - account_deleted - operator_required - account_not_found - account_not_soft_deleted - account_hard_delete_active_resources - file_upload_error - build_error - exec_timeout - exec_failed - file_error - not_implemented - capacity_exceeded - QUOTA_EXCEEDED - feature_unavailable - snapshot_in_use - no_eligible_runtime_host - same_host_required - incompatible_snapshot - rebuild_required - rate_limit_exceeded - transition_in_progress - transition_conflict - agent_deployment_not_found - agent_deployment_version_not_found - agent_run_not_found - agent_service_instance_not_found - agent_deployment_name_conflict - agent_deployment_idempotency_mismatch - agent_deployment_invalid_config - agent_deployment_invalid_state - volume_beta_restriction - volume_invalid_mount_path - volume_overlapping_mounts - volume_backend_capability_unsupported - volume_quota_exceeded - volume_mount_credential_issue_failed - volume_backend_unavailable - volume_stale_revision - volume_busy - volume_read_only - volume_limit_exceeded - internal_error error_detail: $ref: '#/components/schemas/ErrorDetail' request_id: type: string description: Request correlation ID returned in the `x-request-id` header build_id: type: string description: Template build ID when the error is associated with a tracked build ErrorDetail: oneOf: - $ref: '#/components/schemas/TemplateFailureDetail' - $ref: '#/components/schemas/UploadFailureDetail' TemplateFailureDetail: type: object required: - code - message - phase - retryable - suggested_action properties: code: type: string enum: - unauthorized - file_upload_error - build_error - internal_error message: type: string phase: $ref: '#/components/schemas/TemplateFailurePhase' retryable: type: boolean suggested_action: type: string step_index: type: integer attempt: type: integer max_attempts: type: integer cache_subject: type: string build_id: type: string request_id: type: string description: >- Present on terminal request-originated failures and blocking error responses. details: type: object additionalProperties: true description: >- Stable failure metadata. Includes a `reason` key plus phase-specific fields such as `blob_id`, `path`, digest/size mismatch values, `command`, or `alias`. UploadFailureDetail: type: object required: - reason - message - retryable properties: reason: $ref: '#/components/schemas/UploadFailureReason' message: type: string retryable: type: boolean upload_id: type: string request_id: type: string path: type: string description: >- Normalized absolute machine path associated with the failed upload when available. part_number: type: integer format: uint32 details: type: object additionalProperties: true description: >- Additional failure diagnostics; keys depend on the failure reason, deliberately open. TemplateFailurePhase: type: string enum: - auth - preflight - blob_upload - prepare - build_step - readiness - snapshot - finalize - interrupted UploadFailureReason: type: string enum: - insufficient_staging_space - size_limit_exceeded - invalid_part_checksum - part_out_of_range - part_size_mismatch - whole_checksum_mismatch - upload_expired - upload_aborted - upload_already_completed - target_conflict - directory_extract_invalid_path - directory_extract_invalid_symlink - directory_extract_unsupported_entry - missing_parts responses: InvalidRequest: description: Invalid request parameters content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: Missing or invalid bearer credential content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: unauthorized: summary: Missing or invalid bearer credential value: error: Missing or invalid bearer credential code: unauthorized request_id: req_123 AgentDeploymentNotFound: description: >- Agent deployment, version, run, or service instance was not found for the authenticated tenant. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' AgentDeploymentConflict: description: >- Agent deployment request conflicts with existing state, name uniqueness, or idempotency replay semantics. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' RateLimited: description: Request was throttled by abuse controls or rate limits content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' FeatureUnavailable: description: Feature is unavailable in current deployment mode content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: bearerAuth: type: http scheme: bearer description: API key passed as Bearer token ````