Clarity Cloud Functions API

The cloud_functions API from Clarity — 6 operation(s) for cloud_functions.

Operations 14

GET /api/v1/cloud-functions List Functions #
GET /api/v1/cloud-functions/{function_id} Get Function #
GET /api/v1/cloud-functions/{function_id}/runs List Runs #
GET /api/v1/cloud-functions/{function_id}/runs/{run_id} Get Run #
GET /api/v1/cloud-functions/{function_id}/http/{path} Call Function #
POST /api/v1/cloud-functions/{function_id}/http/{path} Call Function #
DELETE /api/v1/cloud-functions/{function_id}/http/{path} Call Function #
PUT /api/v1/cloud-functions/{function_id}/http/{path} Call Function #
PATCH /api/v1/cloud-functions/{function_id}/http/{path} Call Function #
GET /api/v1/cloud-functions/{function_id}/http Call Function #
POST /api/v1/cloud-functions/{function_id}/http Call Function #
DELETE /api/v1/cloud-functions/{function_id}/http Call Function #
PUT /api/v1/cloud-functions/{function_id}/http Call Function #
PATCH /api/v1/cloud-functions/{function_id}/http Call Function #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/onclarity-com:onclarity-com-cloud-functions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

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

OpenAPI Specification

onclarity-com-cloud-functions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fast Cloud Functions API
  version: 0.1.0
tags:
- name: cloud_functions
paths:
  /api/v1/cloud-functions:
    get:
      tags:
      - cloud_functions
      summary: List Functions
      description: The project's functions, newest first, each with its latest run.
      operationId: list_functions_api_v1_cloud_functions_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FunctionListResponse'
      security:
      - HTTPBearer: []
  /api/v1/cloud-functions/{function_id}:
    get:
      tags:
      - cloud_functions
      summary: Get Function
      description: 'One function: its settings, schedule, saved state and deploy status.'
      operationId: get_function_api_v1_cloud_functions__function_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: function_id
        in: path
        required: true
        schema:
          type: integer
          title: Function Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FunctionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/cloud-functions/{function_id}/runs:
    get:
      tags:
      - cloud_functions
      summary: List Runs
      description: Run history, newest first.
      operationId: list_runs_api_v1_cloud_functions__function_id__runs_get
      security:
      - HTTPBearer: []
      parameters:
      - name: function_id
        in: path
        required: true
        schema:
          type: integer
          title: Function Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          default: 50
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          default: 0
          title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/src__cloud_functions__schemas__RunListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/cloud-functions/{function_id}/runs/{run_id}:
    get:
      tags:
      - cloud_functions
      summary: Get Run
      description: 'One run: input, output, error and the log tail of a sync run.'
      operationId: get_run_api_v1_cloud_functions__function_id__runs__run_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: function_id
        in: path
        required: true
        schema:
          type: integer
          title: Function Id
      - name: run_id
        in: path
        required: true
        schema:
          type: integer
          title: Run Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/src__cloud_functions__schemas__RunResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/cloud-functions/{function_id}/http/{path}:
    get:
      tags:
      - cloud_functions
      summary: Call Function
      description: 'Call the function''s route ``/{path}`` with this request''s method, query, headers and body.


        The function gets an API Gateway HTTP API v2 event (a FastAPI app wrapped in Mangum runs

        unchanged) with the user in ``requestContext.authorizer.lambda.user``. A function that fails

        or times out is still a 200 here, wrapping its 502 or 504; the run holds the reason.'
      operationId: call_function_api_v1_cloud_functions__function_id__http__path__get
      security:
      - HTTPBearer: []
      parameters:
      - name: function_id
        in: path
        required: true
        schema:
          type: integer
          title: Function Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpCallResponse'
        '404':
          description: No such function in this project
        '409':
          description: The function does not serve HTTP, or is not deployed
        '413':
          description: The request body is over 4 MB
        '429':
          description: The function is at its concurrency cap; retry later
        '502':
          description: AWS failed the call
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - cloud_functions
      summary: Call Function
      description: 'Call the function''s route ``/{path}`` with this request''s method, query, headers and body.


        The function gets an API Gateway HTTP API v2 event (a FastAPI app wrapped in Mangum runs

        unchanged) with the user in ``requestContext.authorizer.lambda.user``. A function that fails

        or times out is still a 200 here, wrapping its 502 or 504; the run holds the reason.'
      operationId: postApiV1CloudFunctionsByFunctionIdHttpByPath
      security:
      - HTTPBearer: []
      parameters:
      - name: function_id
        in: path
        required: true
        schema:
          type: integer
          title: Function Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpCallResponse'
        '404':
          description: No such function in this project
        '409':
          description: The function does not serve HTTP, or is not deployed
        '413':
          description: The request body is over 4 MB
        '429':
          description: The function is at its concurrency cap; retry later
        '502':
          description: AWS failed the call
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-operation-id-source: normalized
      x-operation-id-original: call_function_api_v1_cloud_functions__function_id__http__path__get
    delete:
      tags:
      - cloud_functions
      summary: Call Function
      description: 'Call the function''s route ``/{path}`` with this request''s method, query, headers and body.


        The function gets an API Gateway HTTP API v2 event (a FastAPI app wrapped in Mangum runs

        unchanged) with the user in ``requestContext.authorizer.lambda.user``. A function that fails

        or times out is still a 200 here, wrapping its 502 or 504; the run holds the reason.'
      operationId: deleteApiV1CloudFunctionsByFunctionIdHttpByPath
      security:
      - HTTPBearer: []
      parameters:
      - name: function_id
        in: path
        required: true
        schema:
          type: integer
          title: Function Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpCallResponse'
        '404':
          description: No such function in this project
        '409':
          description: The function does not serve HTTP, or is not deployed
        '413':
          description: The request body is over 4 MB
        '429':
          description: The function is at its concurrency cap; retry later
        '502':
          description: AWS failed the call
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-operation-id-source: normalized
      x-operation-id-original: call_function_api_v1_cloud_functions__function_id__http__path__get
    put:
      tags:
      - cloud_functions
      summary: Call Function
      description: 'Call the function''s route ``/{path}`` with this request''s method, query, headers and body.


        The function gets an API Gateway HTTP API v2 event (a FastAPI app wrapped in Mangum runs

        unchanged) with the user in ``requestContext.authorizer.lambda.user``. A function that fails

        or times out is still a 200 here, wrapping its 502 or 504; the run holds the reason.'
      operationId: putApiV1CloudFunctionsByFunctionIdHttpByPath
      security:
      - HTTPBearer: []
      parameters:
      - name: function_id
        in: path
        required: true
        schema:
          type: integer
          title: Function Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpCallResponse'
        '404':
          description: No such function in this project
        '409':
          description: The function does not serve HTTP, or is not deployed
        '413':
          description: The request body is over 4 MB
        '429':
          description: The function is at its concurrency cap; retry later
        '502':
          description: AWS failed the call
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-operation-id-source: normalized
      x-operation-id-original: call_function_api_v1_cloud_functions__function_id__http__path__get
    patch:
      tags:
      - cloud_functions
      summary: Call Function
      description: 'Call the function''s route ``/{path}`` with this request''s method, query, headers and body.


        The function gets an API Gateway HTTP API v2 event (a FastAPI app wrapped in Mangum runs

        unchanged) with the user in ``requestContext.authorizer.lambda.user``. A function that fails

        or times out is still a 200 here, wrapping its 502 or 504; the run holds the reason.'
      operationId: patchApiV1CloudFunctionsByFunctionIdHttpByPath
      security:
      - HTTPBearer: []
      parameters:
      - name: function_id
        in: path
        required: true
        schema:
          type: integer
          title: Function Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpCallResponse'
        '404':
          description: No such function in this project
        '409':
          description: The function does not serve HTTP, or is not deployed
        '413':
          description: The request body is over 4 MB
        '429':
          description: The function is at its concurrency cap; retry later
        '502':
          description: AWS failed the call
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-operation-id-source: normalized
      x-operation-id-original: call_function_api_v1_cloud_functions__function_id__http__path__get
  /api/v1/cloud-functions/{function_id}/http:
    get:
      tags:
      - cloud_functions
      summary: Call Function
      description: 'Call the function''s route ``/{path}`` with this request''s method, query, headers and body.


        The function gets an API Gateway HTTP API v2 event (a FastAPI app wrapped in Mangum runs

        unchanged) with the user in ``requestContext.authorizer.lambda.user``. A function that fails

        or times out is still a 200 here, wrapping its 502 or 504; the run holds the reason.'
      operationId: call_function_api_v1_cloud_functions__function_id__http_get
      security:
      - HTTPBearer: []
      parameters:
      - name: function_id
        in: path
        required: true
        schema:
          type: integer
          title: Function Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpCallResponse'
        '404':
          description: No such function in this project
        '409':
          description: The function does not serve HTTP, or is not deployed
        '413':
          description: The request body is over 4 MB
        '429':
          description: The function is at its concurrency cap; retry later
        '502':
          description: AWS failed the call
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - cloud_functions
      summary: Call Function
      description: 'Call the function''s route ``/{path}`` with this request''s method, query, headers and body.


        The function gets an API Gateway HTTP API v2 event (a FastAPI app wrapped in Mangum runs

        unchanged) with the user in ``requestContext.authorizer.lambda.user``. A function that fails

        or times out is still a 200 here, wrapping its 502 or 504; the run holds the reason.'
      operationId: postApiV1CloudFunctionsByFunctionIdHttp
      security:
      - HTTPBearer: []
      parameters:
      - name: function_id
        in: path
        required: true
        schema:
          type: integer
          title: Function Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpCallResponse'
        '404':
          description: No such function in this project
        '409':
          description: The function does not serve HTTP, or is not deployed
        '413':
          description: The request body is over 4 MB
        '429':
          description: The function is at its concurrency cap; retry later
        '502':
          description: AWS failed the call
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-operation-id-source: normalized
      x-operation-id-original: call_function_api_v1_cloud_functions__function_id__http_get
    delete:
      tags:
      - cloud_functions
      summary: Call Function
      description: 'Call the function''s route ``/{path}`` with this request''s method, query, headers and body.


        The function gets an API Gateway HTTP API v2 event (a FastAPI app wrapped in Mangum runs

        unchanged) with the user in ``requestContext.authorizer.lambda.user``. A function that fails

        or times out is still a 200 here, wrapping its 502 or 504; the run holds the reason.'
      operationId: deleteApiV1CloudFunctionsByFunctionIdHttp
      security:
      - HTTPBearer: []
      parameters:
      - name: function_id
        in: path
        required: true
        schema:
          type: integer
          title: Function Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpCallResponse'
        '404':
          description: No such function in this project
        '409':
          description: The function does not serve HTTP, or is not deployed
        '413':
          description: The request body is over 4 MB
        '429':
          description: The function is at its concurrency cap; retry later
        '502':
          description: AWS failed the call
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-operation-id-source: normalized
      x-operation-id-original: call_function_api_v1_cloud_functions__function_id__http_get
    put:
      tags:
      - cloud_functions
      summary: Call Function
      description: 'Call the function''s route ``/{path}`` with this request''s method, query, headers and body.


        The function gets an API Gateway HTTP API v2 event (a FastAPI app wrapped in Mangum runs

        unchanged) with the user in ``requestContext.authorizer.lambda.user``. A function that fails

        or times out is still a 200 here, wrapping its 502 or 504; the run holds the reason.'
      operationId: putApiV1CloudFunctionsByFunctionIdHttp
      security:
      - HTTPBearer: []
      parameters:
      - name: function_id
        in: path
        required: true
        schema:
          type: integer
          title: Function Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpCallResponse'
        '404':
          description: No such function in this project
        '409':
          description: The function does not serve HTTP, or is not deployed
        '413':
          description: The request body is over 4 MB
        '429':
          description: The function is at its concurrency cap; retry later
        '502':
          description: AWS failed the call
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-operation-id-source: normalized
      x-operation-id-original: call_function_api_v1_cloud_functions__function_id__http_get
    patch:
      tags:
      - cloud_functions
      summary: Call Function
      description: 'Call the function''s route ``/{path}`` with this request''s method, query, headers and body.


        The function gets an API Gateway HTTP API v2 event (a FastAPI app wrapped in Mangum runs

        unchanged) with the user in ``requestContext.authorizer.lambda.user``. A function that fails

        or times out is still a 200 here, wrapping its 502 or 504; the run holds the reason.'
      operationId: patchApiV1CloudFunctionsByFunctionIdHttp
      security:
      - HTTPBearer: []
      parameters:
      - name: function_id
        in: path
        required: true
        schema:
          type: integer
          title: Function Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpCallResponse'
        '404':
          description: No such function in this project
        '409':
          description: The function does not serve HTTP, or is not deployed
        '413':
          description: The request body is over 4 MB
        '429':
          description: The function is at its concurrency cap; retry later
        '502':
          description: AWS failed the call
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-operation-id-source: normalized
      x-operation-id-original: call_function_api_v1_cloud_functions__function_id__http_get
components:
  schemas:
    RunSummary:
      properties:
        id:
          type: integer
          title: Id
        status:
          $ref: '#/components/schemas/src__cloud_functions__constants__RunStatus'
        trigger_type:
          $ref: '#/components/schemas/RunTrigger'
        started_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Started At
        finished_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Finished At
        duration_ms:
          anyOf:
          - type: integer
          - type: 'null'
          title: Duration Ms
      type: object
      required:
      - id
      - status
      - trigger_type
      - started_at
      - finished_at
      - duration_ms
      title: RunSummary
      description: 'A run in one line, for a function list: what happened last and when.'
    HttpCallResponse:
      properties:
        status:
          type: integer
          title: Status
          description: The status code the function answered with.
        headers:
          additionalProperties:
            type: string
          type: object
          title: Headers
          description: The function's response headers, lower-case.
        body:
          type: string
          title: Body
          description: 'The body: text as is, anything else base64 (`is_base64_encoded`).'
        is_base64_encoded:
          type: boolean
          title: Is Base64 Encoded
      type: object
      required:
      - status
      - headers
      - body
      - is_base64_encoded
      title: HttpCallResponse
      description: 'A function''s answer to an HTTP call, wrapped so none of its headers reach the browser as

        VoC''s own (a function''s `set-cookie` must not land on VoC''s domain).'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ScheduleStatus:
      type: string
      enum:
      - none
      - enabled
      - paused
      title: ScheduleStatus
    RunTrigger:
      type: string
      enum:
      - manual
      - schedule
      - http
      title: RunTrigger
    src__cloud_functions__constants__RunMode:
      type: string
      enum:
      - sync
      - async
      title: RunMode
    FunctionListResponse:
      properties:
        functions:
          items:
            $ref: '#/components/schemas/FunctionResponse'
          type: array
          title: Functions
      type: object
      required:
      - functions
      title: FunctionListResponse
    src__cloud_functions__schemas__RunResponse:
      properties:
        id:
          type: integer
          title: Id
        function_id:
          type: integer
          title: Function Id
        version:
          type: integer
          title: Version
        trigger_type:
          $ref: '#/components/schemas/RunTrigger'
        mode:
          $ref: '#/components/schemas/src__cloud_functions__constants__RunMode'
        status:
          $ref: '#/components/schemas/src__cloud_functions__constants__RunStatus'
        input:
          additionalProperties: true
          type: object
          title: Input
        output:
          anyOf:
          - {}
          - type: 'null'
          title: Output
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        log_tail:
          anyOf:
          - type: string
          - type: 'null'
          title: Log Tail
        started_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Started At
        finished_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Finished At
        duration_ms:
          anyOf:
          - type: integer
          - type: 'null'
          title: Duration Ms
        created_at:
          type: string
          format: date-time
          title: Created At
        scheduled_for:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Scheduled For
          description: The schedule slot of a scheduled run.
      type: object
      required:
      - id
      - function_id
      - version
      - trigger_type
      - mode
      - status
      - input
      - output
      - error
      - log_tail
      - started_at
      - finished_at
      - duration_ms
      - created_at
      title: RunResponse
    src__cloud_functions__constants__RunStatus:
      type: string
      enum:
      - running
      - succeeded
      - failed
      - timed_out
      title: RunStatus
    src__cloud_functions__schemas__RunListResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/src__cloud_functions__schemas__RunResponse'
          type: array
          title: Items
        total:
          type: integer
          title: Total
      type: object
      required:
      - items
      - total
      title: RunListResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    FunctionStatus:
      type: string
      enum:
      - deploying
      - active
      - failed
      title: FunctionStatus
    FunctionResponse:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        handler:
          type: string
          title: Handler
        timeout_s:
          type: integer
          title: Timeout S
        memory_mb:
          type: integer
          title: Memory Mb
        status:
          $ref: '#/components/schemas/FunctionStatus'
        deploy_error:
          anyOf:
          - type: string
          - type: 'null'
          title: Deploy Error
        current_version:
          anyOf:
          - type: integer
          - type: 'null'
          title: Current Version
        schedule_expression:
          anyOf:
          - type: string
          - type: 'null'
          title: Schedule Expression
        schedule_timezone:
          anyOf:
          - type: string
          - type: 'null'
          title: Schedule Timezone
        schedule_input:
          additionalProperties: true
          type: object
          title: Schedule Input
        schedule_status:
          $ref: '#/components/schemas/ScheduleStatus'
        state:
          additionalProperties: true
          type: object
          title: State
        http_enabled:
          type: boolean
          title: Http Enabled
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        last_run:
          anyOf:
          - $ref: '#/components/schemas/RunSummary'
          - type: 'null'
          description: The newest run, in list responses only.
      type: object
      required:
      - id
      - name
      - description
      - handler
      - timeout_s
      - memory_mb
      - status
      - deploy_error
      - current_version
      - schedule_expression
      - schedule_timezone
      - schedule_input
      - schedule_status
      - state
      - http_enabled
      - created_at
      - updated_at
      title: FunctionResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    HTTPBasic:
      type: http
      scheme: basic