> ## Documentation Index
> Fetch the complete documentation index at: https://developers.nexspace365.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Start a headless agent run

> Enqueue a run of a configured agent definition. The run executes
asynchronously as the credential's bound user (never exceeding that
user's RBAC/suite entitlements) and returns immediately with a `runId`.
Poll `GET /api/agents/{id}/runs/{runId}` or stream
`GET /api/agents/{id}/runs/{runId}/stream` for progress.

One executing run per agent — a second concurrent start returns
`409` with code `AGENT_BUSY`. Requires the `agents:run` scope.




## OpenAPI

````yaml https://api.nexspace365.com/api/openapi.json post /api/agents/{id}/runs
openapi: 3.0.3
info:
  title: NexSpace 365 API
  description: >
    Multi-industry enterprise workforce management platform — scheduling, HR,

    payroll, CRM, AI, and messaging suites.


    ## Authentication

    Three schemes: session cookie, JWT bearer, or API key (`nex_live_…` /

    `nex_test_…` / `nex_pat_…`). AI agents should use API keys with appropriate

    scopes.


    ## Authorization

    Endpoints require specific permissions via the RBAC system:

    - **Internal team**: Full platform access

    - **Facility users**: Scoped to their org/facilities

    - **Staff**: Limited to own data


    ## Error Contract

    All errors return `{ error: { message, code?, suggestion?, retryable? },
    requestId? }`.

    The `suggestion` field hints at how to fix the request; `retryable` signals
    whether

    retry-with-backoff is appropriate.


    ## Versioning

    Pin your integration to a specific API version via the `NexSpace-Version`
    header

    (date-based, e.g. `2026-05-10`). When absent, the latest version is assumed.

    Deprecated versions include `Sunset` and `Deprecation` headers. Discovery at

    `GET /.well-known/api-versions`.


    ## Idempotency

    Write operations (POST/PUT/PATCH) accept an `Idempotency-Key` header. If

    the same key + body combination is sent again within 24 hours, the original

    response is replayed. Different body with the same key returns 409 Conflict.


    ## MCP (Model Context Protocol)

    AI agents interact via `POST /mcp` using JSON-RPC 2.0. Call `tools/list` to

    discover available verbs, then `tools/call` to invoke them.
  version: 1.0.0
  contact:
    name: NexSpace API Support
    email: support@nexspace365.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.nexspace365.com
    description: Production server
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Authentication
    description: User authentication and session management
  - name: Facilities
    description: Facility management
  - name: Staff
    description: Staff member management and profiles
  - name: Credentials
    description: Staff credential tracking — licenses, certifications, and training
  - name: Shifts
    description: Shift scheduling and management
  - name: Dashboard
    description: Dashboard statistics and widgets
  - name: API Keys
    description: API key lifecycle — create, list, revoke, rotate
  - name: MCP
    description: Model Context Protocol endpoint for AI agent tool calling
  - name: OAuth
    description: OAuth 2.1 authorization server — DCR, authorize, token
  - name: Webhooks
    description: Outbound webhook subscription management
  - name: Analytics
    description: API usage analytics and observability
paths:
  /api/agents/{id}/runs:
    post:
      tags:
        - Agents
      summary: Start a headless agent run
      description: |
        Enqueue a run of a configured agent definition. The run executes
        asynchronously as the credential's bound user (never exceeding that
        user's RBAC/suite entitlements) and returns immediately with a `runId`.
        Poll `GET /api/agents/{id}/runs/{runId}` or stream
        `GET /api/agents/{id}/runs/{runId}/stream` for progress.

        One executing run per agent — a second concurrent start returns
        `409` with code `AGENT_BUSY`. Requires the `agents:run` scope.
      operationId: createAgentRun
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: Agent definition id.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                message:
                  type: string
                  maxLength: 20000
                  description: The instruction that seeds the run.
                resumeSessionId:
                  type: string
                  description: >-
                    Continue an existing conversation (multi-turn) instead of
                    starting fresh.
              required:
                - message
      responses:
        '202':
          description: Run accepted and executing
          content:
            application/json:
              schema:
                type: object
                properties:
                  runId:
                    type: string
                  status:
                    type: string
                    enum:
                      - running
                  agentId:
                    type: integer
                  requestId:
                    type: string
        '403':
          description: Credential missing the agents:run scope
        '404':
          description: Agent definition not found
        '409':
          description: The agent already has a run in progress (code AGENT_BUSY)
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token authentication
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: NexSpaceApiKey
      description: |
        API key or personal access token (NEX-1042). Send as
        `Authorization: Bearer <token>`. Token format:
          - `nex_live_…`  — live API key (server-to-server)
          - `nex_test_…`  — sandbox API key
          - `nex_pat_…`   — personal access token (acts as the issuing user)

        Authorization is decided by the key's `scopes` array, not the
        owning user's RBAC role. See `POST /api/api-keys` to mint a key.

````