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

# Live capacity

> How busy Revcenter is right now: searches running and waiting across the platform and in this workspace, and about when a search launched now would start. Launches are never refused for being busy: a search past the platform's limit waits its turn (status queued) and starts as one finishes. Workspaces take turns, so a workspace with many searches waiting does not hold up another's first one. Use this to tell the person what to expect before launching many searches at once. Does not use credits.

Needs scope `searches:read`.



## OpenAPI

````yaml /openapi.json get /capacity
openapi: 3.1.0
info:
  title: Revcenter API
  version: v1
  description: >-
    Projects, searches, scored candidates and shortlists. Generated from the
    agent API's registry.
servers:
  - url: https://api.revcenter.ai/v1
security:
  - bearer: []
tags:
  - name: Login
  - name: Account
  - name: Actions
  - name: Reference
  - name: Projects
  - name: Searches
  - name: Scoring
  - name: Shortlists
  - name: Candidates
  - name: Webhooks
  - name: Health
paths:
  /capacity:
    get:
      tags:
        - Searches
      summary: Live capacity
      description: >-
        How busy Revcenter is right now: searches running and waiting across the
        platform and in this workspace, and about when a search launched now
        would start. Launches are never refused for being busy: a search past
        the platform's limit waits its turn (status queued) and starts as one
        finishes. Workspaces take turns, so a workspace with many searches
        waiting does not hold up another's first one. Use this to tell the
        person what to expect before launching many searches at once. Does not
        use credits.


        Needs scope `searches:read`.
      operationId: get_capacity
      responses:
        '200':
          description: OK
          headers:
            X-RateLimit-Limit:
              description: >-
                Requests allowed this minute (the tighter of the key's and the
                workspace's).
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left this minute.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: When the minute resets, in Unix seconds.
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Capacity'
                  meta:
                    $ref: '#/components/schemas/Meta'
              example:
                data:
                  queue_enabled: true
                  platform:
                    search_slots: 20
                    running: 20
                    waiting: 14
                    typical_search_seconds: 300
                    searches_per_hour: 240
                  workspace:
                    running: 6
                    waiting: 9
                  new_search:
                    position: 15
                    ahead: 14
                    starts_in_seconds: 420
                meta:
                  request_id: req_01JABCDEF
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '402':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '409':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
components:
  schemas:
    Capacity:
      type: object
      properties:
        queue_enabled:
          type: boolean
        platform:
          type: object
          properties:
            search_slots:
              type: integer
              description: Searches that run at once across the platform.
            running:
              type: integer
            waiting:
              type: integer
            typical_search_seconds:
              type: integer
              description: Median time from start to finish of a recent search.
            searches_per_hour:
              type: integer
              description: >-
                About how many searches the platform finishes an hour at that
                pace.
        workspace:
          type: object
          properties:
            running:
              type: integer
            waiting:
              type: integer
        new_search:
          type: object
          description: >-
            Where a search launched now would stand: 0 seconds when it would
            start at once.
          properties:
            position:
              type: integer
            ahead:
              type: integer
            starts_in_seconds:
              type: integer
    Meta:
      type: object
      properties:
        request_id:
          type: string
        total:
          type: integer
          description: On lists that count everything that matched.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: 'Stable: every code is on the Errors page.'
            message:
              type: string
            details:
              type:
                - object
                - 'null'
              description: >-
                Structured specifics, when there are any (for example
                retry_after_seconds).
            request_id:
              type: string
        meta:
          $ref: '#/components/schemas/Meta'
      example:
        error:
          code: search_not_found
          message: No search with that id in this workspace.
          details: null
          request_id: req_01JABCDEF
        meta:
          request_id: req_01JABCDEF
  responses:
    Error:
      description: 'An error: one envelope everywhere. A 429 carries Retry-After.'
      headers:
        X-RateLimit-Limit:
          description: >-
            Requests allowed this minute (the tighter of the key's and the
            workspace's).
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left this minute.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: When the minute resets, in Unix seconds.
          schema:
            type: integer
        Retry-After:
          description: Seconds to wait (on 429 and 503).
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: An API key from Settings → Usage → API (rvc_live_…).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.