Allowly Runtime API
Deterministic hiring policy decisions and signed evidence records
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Deterministic hiring policy decisions and signed evidence records
Endpoints 128
internal
- POSTPost Execution Witness Session Claim
/internal/execution-witness/sessions/:session_id/claim - POSTProvision Workspace
/internal/workspaces - GETGet Workspace Agent Credentials
/internal/workspaces/:workspace_id/agent-credentials?agent_id=string - DELETERevoke Workspace Agent Credential
/internal/workspaces/:workspace_id/agent-credentials/:key_id - POSTReplace Agent Trial Credentials
/internal/workspaces/:workspace_id/agent-trial/credentials - POSTTransition Agent Trial
/internal/workspaces/:workspace_id/agent-trial/lifecycle - GETAgent Trial Status
/internal/workspaces/:workspace_id/agent-trial/status - GETList Workspace Api Keys
/internal/workspaces/:workspace_id/api-keys - POSTCreate Workspace Api Key
/internal/workspaces/:workspace_id/api-keys - PATCHUpdate Workspace Api Key Label
/internal/workspaces/:workspace_id/api-keys/:key_id/label - PATCHRevoke Workspace Api Key
/internal/workspaces/:workspace_id/api-keys/:key_id/revoke - POSTCreate Workspace Authorization
/internal/workspaces/:workspace_id/authorizations - GETWorkspace Authorization Audit Package
/internal/workspaces/:workspace_id/authorizations/:authorization_id/audit-packageBuild an audit artifact containing retained signed receipts, the issuer keys document, a manifest, and offline verification steps (spec §3.5). - PUTClose Workspace
/internal/workspaces/:workspace_id/close - GETClosure Retention Status
/internal/workspaces/:workspace_id/closure-retention-status - POSTPost Workspace Custom Executable
/internal/workspaces/:workspace_id/custom-executables - GETWorkspace Dashboard Insights
/internal/workspaces/:workspace_id/dashboard/insights - GETList Workspace Dashboard Pending Prompts
/internal/workspaces/:workspace_id/dashboard/pending-prompts - POSTResolve Workspace Dashboard Pending Prompt
/internal/workspaces/:workspace_id/dashboard/pending-prompts/:prompt_id/resolve - GETList Workspace Dashboard Receipts
/internal/workspaces/:workspace_id/dashboard/receipts - GETGet Workspace Dashboard Receipt
/internal/workspaces/:workspace_id/dashboard/receipts/:receipt_id - GETWorkspace Dashboard Stats
/internal/workspaces/:workspace_id/dashboard/stats - GETWorkspace Dashboard Summary
/internal/workspaces/:workspace_id/dashboard/summary - POSTVerify Workspace Dashboard Receipt
/internal/workspaces/:workspace_id/dashboard/verify - GETGet Workspace Enabled Executables
/internal/workspaces/:workspace_id/enabled-executables - POSTPost Workspace Enabled Executable
/internal/workspaces/:workspace_id/enabled-executables - DELETEDelete Workspace Enabled Executable
/internal/workspaces/:workspace_id/enabled-executables/:enabled_executable_id - PATCHSync Workspace Entitlements
/internal/workspaces/:workspace_id/entitlements - GETGet Workspace Executable Catalog
/internal/workspaces/:workspace_id/executable-catalog - DELETERevoke Workspace Hiring Credentials
/internal/workspaces/:workspace_id/hiring/agent-credentials - POSTCreate Workspace Hiring Authorization
/internal/workspaces/:workspace_id/hiring/authorizations - GETGet Workspace Identity Binding
/internal/workspaces/:workspace_id/identity-bindings?agent_id=string - PUTPut Workspace Identity Binding
/internal/workspaces/:workspace_id/identity-bindings - DELETEDelete Workspace Identity Binding
/internal/workspaces/:workspace_id/identity-bindings?agent_id=string - GETGet Workspace Auth0 Connection
/internal/workspaces/:workspace_id/identity/auth0 - PUTPut Workspace Auth0 Connection
/internal/workspaces/:workspace_id/identity/auth0 - DELETEDelete Workspace Auth0 Connection
/internal/workspaces/:workspace_id/identity/auth0 - POSTCreate Observe Assessment
/internal/workspaces/:workspace_id/observe/assessments - GETGet Observe Assessment
/internal/workspaces/:workspace_id/observe/assessments/:assessment_id - POSTPreview Workspace Policy
/internal/workspaces/:workspace_id/policies/preview - POSTValidate Workspace Policy
/internal/workspaces/:workspace_id/policies/validateRead-only policy preflight before the control plane provisions Witness. - GETList Workspace Policy Alerts
/internal/workspaces/:workspace_id/policy-alerts?issued_after=2024-01-01T00:00:00ZRead pending denial notifications above a fixed activation floor without claiming them. - POSTAcknowledge Workspace Policy Alerts
/internal/workspaces/:workspace_id/policy-alerts/ackAcknowledge exact eligible IDs only after the control plane commits their ingestion. - GETList Workspace Receipt Exports
/internal/workspaces/:workspace_id/receipt-exports - POSTCreate Workspace Receipt Export
/internal/workspaces/:workspace_id/receipt-exports - GETGet Workspace Receipt Export
/internal/workspaces/:workspace_id/receipt-exports/:export_id - GETGet Workspace Receipt Export Artifact
/internal/workspaces/:workspace_id/receipt-exports/:export_id/artifact - GETList Workspace Receipt Retention Runs
/internal/workspaces/:workspace_id/receipt-retention-runs - POSTCreate Workspace Receipt Retention Run
/internal/workspaces/:workspace_id/receipt-retention-runs - GETGet Workspace Receipt Retention Run
/internal/workspaces/:workspace_id/receipt-retention-runs/:run_id - POSTCreate Workspace Seal
/internal/workspaces/:workspace_id/seal - GETList Workspace Seal Receipts
/internal/workspaces/:workspace_id/seal/receipts - GETGet Workspace Seal Webhook
/internal/workspaces/:workspace_id/seal/webhook - POSTEnsure Workspace Seal Webhook
/internal/workspaces/:workspace_id/seal/webhook - DELETEDisable Workspace Seal Webhook
/internal/workspaces/:workspace_id/seal/webhook - POSTRotate Workspace Seal Webhook
/internal/workspaces/:workspace_id/seal/webhook/rotate - GETWorkspace Usage Counters
/internal/workspaces/:workspace_id/usage/counters - GETGet Workspace Witness Public Key
/internal/workspaces/:workspace_id/witness-key - PATCHSync Workspace Witness Key
/internal/workspaces/:workspace_id/witness-keySync only the Witness reference; never overwrite billing/signing state.
authorizations
- GETList Authorizations
/v1/authorizations - POSTCreate Authorization
/v1/authorizations - DELETERevoke Authorization
/v1/authorizations/:authorization_id - GETList Policies
/v1/policies - POSTCreate Policy
/v1/policies - GETGet Policy
/v1/policies/:policy_id - DELETEDelete Policy
/v1/policies/:policy_id
budget-settlements
- POSTSettle Budget
/v1/budget-settlements
check
- POSTCheck
/v1/check
confirmations
- GETGet Confirmation
/v1/confirmations/:confirmation_id/statusRead the recorded choice and grant lifecycle; run a fresh check before acting. Accepts the opaque confirmation_id from /v1/check, never a bearer nonce. Legacy… - POSTApprove Confirmation
/v1/confirmations/:nonce
escalations
- GETGet Escalation
/v1/escalations/:escalation_idRead the recorded choice and one-use grant lifecycle; run a fresh check before acting. An approved choice remains approved after its grant expires or is… - POSTResolve
/v1/escalations/:escalation_id/resolve
governed execution
- POSTExecute
/v1/execute - GETGet Execution
/v1/executions/:operation_id - POSTContinue Customer Execution
/v1/executions/:operation_id/continueContinue only the original, undispatched native waiting operation. A webhook is a wake-up, not authority. This route validates the exact saved request and… - POSTClaim Customer Execution Dispatch
/v1/executions/:operation_id/dispatch - POSTReport Customer Execution Outcome
/v1/executions/:operation_id/outcome - POSTCreate Customer Execution Witness Token
/v1/executions/:operation_id/witness-session-token
Observe
- POSTSubmit Observe Event
/v1/observe/events - GETGet Observe Event
/v1/observe/events/:event_id
receipts
- GETList Receipts
/v1/receipts - GETGet Receipt
/v1/receipts/:receipt_id
receipt acknowledgments
- POSTAcknowledge Receipt
/v1/receipts/:receipt_id/acknowledgments - GETGet Receipt Acknowledgment
/v1/receipts/:receipt_id/acknowledgments/:acknowledgment_id
seal
- POSTCreate Seal
/v1/seal - POSTCreate Webhook Seal
/v1/seal/webhooks?token=string - GETGet Webhook Delivery
/v1/seal/webhooks/deliveries/:attempt_id?token=string - GETGet Webhook Keys
/v1/seal/webhooks/keys?token=string - GETGet Webhook Receipt
/v1/seal/webhooks/receipts/:receipt_id?token=string
setup
- GETList Actions
/v1/setup/actions - POSTCreate Action
/v1/setup/actions - DELETEDelete Action
/v1/setup/actions/:action_id - PATCHUpdate Action
/v1/setup/actions/:action_id - DELETERevoke Current Credential
/v1/setup/credentialRevoke the bearer credential used for this request. This cannot revoke another device's credential. Internal service authentication is not accepted. - GETList Policies
/v1/setup/policies - POSTCreate Policy
/v1/setup/policies - POSTPreview Policy
/v1/setup/policies/preview - POSTPublish Policy
/v1/setup/policies/publish - GETGet Policy
/v1/setup/policies/:policy_id - DELETEDelete Policy
/v1/setup/policies/:policy_id - POSTCreate Runtime Key
/v1/setup/runtime-keys - GETSetup Status
/v1/setup/status
identity and execution setup
- GETRead Agent Credentials
/v1/setup/agent-credentials?agent_id=string - POSTEnroll Agent Credential
/v1/setup/agent-credentials - DELETERemove Agent Credential
/v1/setup/agent-credentials/:key_id - GETRead Agent Binding
/v1/setup/identity-bindings?agent_id=string - PUTPut Agent Binding
/v1/setup/identity-bindings - DELETERemove Agent Binding
/v1/setup/identity-bindings?agent_id=string - GETRead Auth0 Connection
/v1/setup/identity/auth0 - PUTPut Auth0 Connection
/v1/setup/identity/auth0 - DELETERemove Auth0 Connection
/v1/setup/identity/auth0 - GETRead Witness Public Key
/v1/setup/witness-key
executable catalog
- POSTPost Custom Executable
/v1/setup/custom-executables - GETGet Enabled Executables
/v1/setup/enabled-executables - POSTPost Enabled Executable
/v1/setup/enabled-executables - DELETEDelete Enabled Executable
/v1/setup/enabled-executables/:enabled_executable_id - GETGet Executable Catalog
/v1/setup/executable-catalog
resolution-webhooks
- GETGet Config
/v1/setup/resolution-webhookRead callback configuration. Signing secrets are returned only by PUT/rotate. - PUTPut Config
/v1/setup/resolution-webhookConfigure one HTTPS callback. URL changes/re-enabling cancel queued old events. Repeating the enabled URL returns the same current secret without rotation.… - DELETEDisable
/v1/setup/resolution-webhookDisable callbacks and cancel queued events; terminal metadata remains retained. - GETDeliveries
/v1/setup/resolution-webhook/deliveriesReturn at most 20 recent delivery summaries, without payloads, URLs, or secrets. - POSTRotate
/v1/setup/resolution-webhook/rotateRotate the signing credential and cancel every queued event for the old version.
tombstones
- GETList Tombstones
/v1/tombstones - POSTCreate Tombstone
/v1/tombstones
workspaces
- GETGet Workspace Keys
/v1/workspaces/:workspace_id/keys
- GETRoot
/ - GETHealthz
/healthz - GETReadyz
/readyz
API details
- Authentication
- A bearer token in the Authorization header
- Operations
- 128 operations on 101 pathsGET 56POST 45DELETE 16PUT 6PATCH 5
- Main resources
- internal 59setup 13identity and execution setup 10authorizations 7governed execution 6executable catalog 5resolution-webhooks 5seal 5Observe 2confirmations 2
- Response formats
application/json- Webhooks
- 2 described
- Description format
- OpenAPI 3.1.0, API version
0.1.0 - Links
- OpenAPI document
- Listed from
- Allowly's published OpenAPI description
How to test the Allowly Runtime API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Allowly Runtime API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Post Execution Witness Session Claim” (POST /internal/execution-witness/sessions/:session_id/claim), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Allowly Runtime API?
Deterministic hiring policy decisions and signed evidence records It is listed under Data & analytics and has 128 endpoints.
Who publishes the Allowly Runtime API?
It is listed from Allowly's public API description (an OpenAPI document), not published by Allowly on Swastik Codes. Anyone who controls allowly.ai can claim the profile by adding a DNS TXT record.
How do I authenticate with the Allowly Runtime API?
With A bearer token in the Authorization header.
How many endpoints does the Allowly Runtime API have?
128 operations on 101 paths (56 GET, 45 POST, 16 DELETE, 6 PUT, 5 PATCH). The largest groups are internal, setup, identity and execution setup, authorizations.
Is forking the Allowly Runtime API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.