Clarity Cloud Functions Relay API
The cloud_functions_relay API from Clarity — 2 operation(s) for cloud_functions_relay.
The cloud_functions_relay API from Clarity — 2 operation(s) for cloud_functions_relay.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/onclarity-com:onclarity-com-cloud-functions-relay-api"
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.
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: 3.2.0
info:
title: Fast Cloud Functions Relay API
version: 0.1.0
tags:
- name: cloud_functions_relay
paths:
/api/admin/v1/cloud-functions/scheduled-runs:
post:
tags:
- cloud_functions_relay
summary: Start Scheduled Run
description: 'A schedule fired: start an async run with the schedule''s input. A paused schedule, or a
previous run still going, answers 409 and the fire is skipped; a wrong token answers 404. The
same fire delivered again returns the run it started.'
operationId: start_scheduled_run_api_admin_v1_cloud_functions_scheduled_runs_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledRunRequest'
required: true
responses:
'202':
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'
security:
- HTTPBearer: []
/api/admin/v1/cloud-functions/runs/{run_id}/result:
post:
tags:
- cloud_functions_relay
summary: Record Run Result
description: 'An async run ended. Idempotent: a run that already finished is returned unchanged. A wrong
run token answers 404, as an unknown run does.'
operationId: record_run_result_api_admin_v1_cloud_functions_runs__run_id__result_post
security:
- HTTPBearer: []
parameters:
- name: run_id
in: path
required: true
schema:
type: integer
title: Run Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RunResultRequest'
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'
components:
schemas:
ScheduledRunRequest:
properties:
project_id:
type: integer
title: Project Id
function_id:
type: integer
title: Function Id
token:
anyOf:
- type: string
- type: 'null'
title: Token
description: The schedule's relay token; a fire without it is refused.
scheduled_for:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Scheduled For
description: The fire's scheduled time; a fire delivered twice starts one run.
type: object
required:
- project_id
- function_id
title: ScheduledRunRequest
description: What the relay sends when a schedule fires (the schedule's input).
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
RunTrigger:
type: string
enum:
- manual
- schedule
- http
title: RunTrigger
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
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
src__cloud_functions__constants__RunMode:
type: string
enum:
- sync
- async
title: RunMode
RunResultRequest:
properties:
project_id:
type: integer
title: Project Id
run_token:
anyOf:
- type: string
- type: 'null'
title: Run Token
description: '`run.token` from the event; a result without it is refused.'
condition:
type: string
title: Condition
description: '`Success`, `RetriesExhausted` or `EventAgeExceeded`.'
function_error:
anyOf:
- type: string
- type: 'null'
title: Function Error
response_payload:
anyOf:
- {}
- type: 'null'
title: Response Payload
type: object
required:
- project_id
- condition
title: RunResultRequest
description: 'The parts of a Lambda destination record the relay forwards. It drops ``requestPayload``,
which holds the project key.'
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
HTTPBasic:
type: http
scheme: basic