find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/hlix-ai:hlix-ai-pending-requests-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: Explore the Hlix API for projects, agent teams, and delivery workflows. Authenticate with `x-api-key` and select a Workspace with `X-Organization-Id`. Session-only operations require a signed-in user session. Authentication setup.
  title: reference Pending Requests API
  version: 1.0.0
servers:
- url: https://server.hlix.ai
  description: API server
security:
- apiKey: []
- sessionCookie: []
tags:
- name: pending-requests
paths:
  /v1/api/pending-requests:
    get:
      operationId: listPendingRequests
      parameters:
      - description: '`pending` | `approved` | `denied` | `cancelled`. Omitted, every status is listed.'
        in: query
        name: status
        required: false
        schema:
          type: string
      - description: Only requests raised against this cycle.
        in: query
        name: cycleId
        required: false
        schema:
          type: string
      - description: Only requests raised against this task.
        in: query
        name: taskId
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      - $ref: '#/components/parameters/ClientPortal'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PendingRequestListItem'
                type: array
          description: The matching requests, each with the project it waits in.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The request named no active organization.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
      summary: List requests awaiting a decision
      tags:
      - pending-requests
  /v1/api/pending-requests/client-question:
    post:
      operationId: askClientQuestion
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AskClientQuestion'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PendingRequest'
          description: The stored nonblocking request. Dispatch does not wait for it. `requestType` and `requiredActor` are assigned by the server.
        '400':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/ApiError'
          description: The JSON body failed schema validation (`ValidationError`), or the request named no active organization (`ApiError`).
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Client collaborators cannot create customer approval requests. This action is restricted to agency members.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No such cycle in this workspace.
      summary: Ask the customer a question
      tags:
      - pending-requests
  /v1/api/pending-requests/{id}:
    get:
      operationId: getPendingRequest
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      - $ref: '#/components/parameters/ClientPortal'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PendingRequest'
          description: The request.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The request named no active organization.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No such request in this workspace — or the caller may not decide it, which answers the same 404 rather than confirming it exists.
      summary: Get one request
      tags:
      - pending-requests
  /v1/api/pending-requests/{id}/cancel:
    post:
      operationId: cancelPendingRequest
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PendingRequest'
          description: The request was cancelled. A blocking dispatch request is treated as denied, so the cycle fails and the project can continue.
        '400':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/ApiError'
          description: The request is no longer `pending` (it was already approved, denied or cancelled), the JSON body failed validation, or the request named no active organization.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No such request in this workspace — or the caller may not decide it, which answers the same 404 rather than confirming it exists.
      summary: Cancel a request nobody will decide
      tags:
      - pending-requests
  /v1/api/pending-requests/{id}/resolve:
    post:
      operationId: resolvePendingRequest
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      - $ref: '#/components/parameters/ClientPortal'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResolvePendingRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PendingRequest'
          description: The decided request. For client collaborators, `decidedBy` is resolved by the server; a value supplied in the body is ignored.
        '400':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/ApiError'
          description: The request is no longer `pending` (it was already approved, denied or cancelled), the JSON body failed validation, or the request named no active organization.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No such request in this workspace — or the caller may not decide it, which answers the same 404 rather than confirming it exists.
      summary: Approve or deny a request
      tags:
      - pending-requests
components:
  schemas:
    ApiError:
      additionalProperties: {}
      properties:
        error:
          type: string
      required:
      - error
      type: object
    PendingRequest:
      properties:
        blocking:
          type: boolean
        context: {}
        createdAt:
          type: string
        cycleId:
          type:
          - string
          - 'null'
        deadline:
          type:
          - string
          - 'null'
        decidedAt:
          type:
          - string
          - 'null'
        decidedBy:
          type:
          - string
          - 'null'
        decision:
          type:
          - string
          - 'null'
        description:
          type: string
        id:
          type: string
        organizationId:
          type: string
        requestType:
          enum:
          - plan_approval
          - code_review
          - conflict_resolution
          - budget_exceeded
          - requirement_clarification
          - deployment_approval
          - cycle_proposal
          - tool_permission
          type: string
        requiredActor:
          enum:
          - system
          - user
          - admin
          - client
          type: string
        resultingAction: {}
        status:
          enum:
          - pending
          - approved
          - denied
          - expired
          - cancelled
          type: string
        taskId:
          type:
          - string
          - 'null'
        title:
          type: string
        updatedAt:
          type: string
      required:
      - id
      - organizationId
      - cycleId
      - taskId
      - requestType
      - blocking
      - requiredActor
      - title
      - description
      - context
      - status
      - decision
      - decidedBy
      - decidedAt
      - deadline
      - resultingAction
      - createdAt
      - updatedAt
      type: object
    ResolvePendingRequest:
      properties:
        decidedBy:
          maxLength: 200
          type: string
        decision:
          maxLength: 5000
          type: string
        feedback:
          maxLength: 5000
          type: string
        status:
          enum:
          - approved
          - denied
          type: string
      required:
      - status
      type: object
    AskClientQuestion:
      additionalProperties: false
      properties:
        cycleId:
          minLength: 1
          type: string
        question:
          maxLength: 5000
          minLength: 1
          type: string
        title:
          maxLength: 200
          minLength: 1
          type: string
      required:
      - cycleId
      - title
      - question
      type: object
    ValidationError:
      properties:
        error:
          properties:
            message:
              type: string
            name:
              type: string
          required:
          - name
          - message
          type: object
        success:
          const: false
          type: boolean
      required:
      - success
      - error
      type: object
    PendingRequestListItem:
      properties:
        blocking:
          type: boolean
        context: {}
        createdAt:
          type: string
        cycleId:
          type:
          - string
          - 'null'
        deadline:
          type:
          - string
          - 'null'
        decidedAt:
          type:
          - string
          - 'null'
        decidedBy:
          type:
          - string
          - 'null'
        decision:
          type:
          - string
          - 'null'
        description:
          type: string
        id:
          type: string
        organizationId:
          type: string
        projectId:
          type:
          - string
          - 'null'
        projectName:
          type:
          - string
          - 'null'
        requestType:
          enum:
          - plan_approval
          - code_review
          - conflict_resolution
          - budget_exceeded
          - requirement_clarification
          - deployment_approval
          - cycle_proposal
          - tool_permission
          type: string
        requiredActor:
          enum:
          - system
          - user
          - admin
          - client
          type: string
        resultingAction: {}
        status:
          enum:
          - pending
          - approved
          - denied
          - expired
          - cancelled
          type: string
        taskId:
          type:
          - string
          - 'null'
        title:
          type: string
        updatedAt:
          type: string
      required:
      - id
      - organizationId
      - cycleId
      - taskId
      - requestType
      - blocking
      - requiredActor
      - title
      - description
      - context
      - status
      - decision
      - decidedBy
      - decidedAt
      - deadline
      - resultingAction
      - createdAt
      - updatedAt
      - projectId
      - projectName
      type: object
  parameters:
    ClientPortal:
      description: The agency Workspace ID for a signed-in client's portal requests. A verified user session and portal membership are required; API keys cannot authenticate portal access. This header does not grant agency administration access.
      in: header
      name: X-Client-Portal
      required: false
      schema:
        type: string
    OrganizationId:
      description: The workspace (organization) to act in. Omitted, the session's active organization is used.
      in: header
      name: X-Organization-Id
      required: false
      schema:
        type: string
      example: YOUR_WORKSPACE_ID
  securitySchemes:
    apiKey:
      description: An API key issued through `/v1/api/auth/api-key/*`. Browser clients can use their session cookie instead.
      in: header
      name: x-api-key
      type: apiKey
    sessionCookie:
      description: The complete session Cookie header issued by sign-in at the selected API host. Cookie names vary by hosting region and environment; preserve the issued name and value. Browsers send these HTTP-only cookies automatically. Session-only operations require this user session and do not accept an API key.
      in: header
      name: Cookie
      type: apiKey