> ## Documentation Index > Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get input request > Return an input request. ## OpenAPI ````yaml /cloud/rest/openapi.json get /input-requests/{input_request_id} openapi: 3.1.0 info: title: Veryfront REST API reference version: 1.0.0 description: |- ## Explore the API | Domain | Use it to | | --- | --- | | [Projects](#tag/projects) | Manage projects and files. | | [Agents](#tag/agents) | Manage agent primitives. | | [Orchestration](#tag/execution) | Manage conversations and runs. | | [Evaluations](#tag/evaluations) | Manage evaluations and results. | | [AI Gateway](#tag/ai-gateway) | Access models and inference. | | [MCP](#tag/mcp) | Discover tools and authorization. | | [Integrations](#tag/integrations) | Manage connections and integrations. | | [Knowledge](#tag/knowledge) | Manage documents and search. | | [Deployments](#tag/deployments) | Manage releases and deployments. | | [Runtime](#tag/runtime) | Manage environments and infrastructure. | | [Observability](#tag/observability) | Monitor activity and performance. | | [Identity & Access](#tag/identity-access) | Manage identity and access. | | [Billing & Usage](#tag/billing-usage) | Manage billing and usage. | | [Other](#tag/platform) | Inspect health and API metadata. | [OpenAPI specification (JSON)](/openapi.json) contact: name: Veryfront API Support url: https://veryfront.com/docs email: support@veryfront.com x-api-id: 5f1f0b8a-6b0e-4c1a-9b35-0f3a1e6d84c7 x-audience: external-public servers: - url: https://api.veryfront.com security: - bearerAuth: [] - apiKeyAuth: [] tags: - name: projects description: Manage projects and files. - name: agents description: Manage agent primitives. - name: execution description: Manage conversations and runs. - name: evaluations description: Manage evaluations and results. - name: ai-gateway description: Access models and inference. - name: mcp description: Discover tools and authorization. - name: integrations description: Manage connections and integrations. - name: knowledge description: Manage documents and search. - name: deployments description: Manage releases and deployments. - name: runtime description: Manage environments and infrastructure. - name: observability description: Monitor activity and performance. - name: identity-access description: Manage identity and access. - name: billing-usage description: Manage billing and usage. - name: platform description: Inspect health and API metadata. - name: projects/Projects - name: projects/Projects/Favorites - name: projects/Projects/Account Projects - name: projects/Projects/Projects - name: projects/Projects/Project Labels - name: projects/Projects/Project templates - name: projects/Files - name: projects/Files/Files - name: projects/Files/File Chunks - name: projects/Files/Branch File Versions - name: projects/Files/Branch Files - name: projects/Files/Environment Files - name: projects/Files/File Versions - name: projects/Files/Branch File Drafts - name: projects/Files/Release Files - name: projects/Files/Sandbox Files - name: projects/Files/File Search - name: projects/Branches - name: projects/Branches/Branches - name: projects/Branches/Branch Policies - name: projects/Branches/Branch Approvals - name: projects/Branches/Branch Status Checks - name: projects/Branches/Project Commits - name: projects/Branches/Branch Merges - name: projects/Uploads - name: projects/Uploads/Upload Folders - name: projects/Uploads/Upload Grants - name: projects/Uploads/Project Uploads - name: projects/Uploads/Upload Visibility - name: agents/Agents - name: agents/Agents/Agents - name: agents/Agents/Agent Labels - name: agents/Agents/Agent templates - name: agents/Agents/Agent Tool References - name: agents/Agents/Agent Avatars - name: agents/Agents/Agent Capabilities - name: agents/Agents/Agent Installation - name: agents/Prompts - name: agents/Prompts/Project prompts - name: agents/Tools - name: agents/Tools/Project tools - name: agents/Skills - name: agents/Skills/Project skills - name: agents/Resources - name: agents/Resources/Project resources - name: agents/Tasks - name: agents/Tasks/Tasks - name: agents/Workflows - name: agents/Workflows/Workflows - name: execution/Conversations - name: execution/Conversations/Conversations - name: execution/Conversations/Conversation messages - name: execution/Conversations/Conversation participants - name: execution/Conversations/Conversation read state - name: execution/Triggers - name: execution/Triggers/Project schedules - name: execution/Triggers/Webhooks - name: execution/Triggers/Webhook events - name: execution/Runs - name: execution/Runs/Run Input Requests - name: execution/Runs/Runs - name: execution/Runs/Runtime - name: execution/Runs/Child Runs - name: execution/Runs/Conversation Runs - name: execution/Runs/Project Runs - name: execution/Runs/Webhook Runs - name: execution/Runs/Run Events - name: execution/Runs/Run Actions - name: execution/Runs/Run Artifacts - name: execution/Executors - name: execution/Executors/Connected agents - name: execution/Executors/Agent workers - name: evaluations/Evaluations - name: evaluations/Evaluations/Evaluations - name: evaluations/Evaluations/Evaluation Runs - name: ai-gateway/Models - name: ai-gateway/Models/Model discovery - name: ai-gateway/Models/Inference Models - name: ai-gateway/Models/Project inference policy - name: ai-gateway/Models/Account inference policy - name: ai-gateway/Inference - name: ai-gateway/Inference/OpenAI Chat Completions - name: ai-gateway/Inference/Embeddings - name: ai-gateway/Inference/OpenAI Responses - name: ai-gateway/Inference/Proxy metadata - name: ai-gateway/Inference/Anthropic Messages - name: ai-gateway/Inference/Provider gateway - name: ai-gateway/Inference/Gemini inference - name: ai-gateway/Inference/Image generation - name: mcp/Tools - name: mcp/Tools/MCP discovery - name: mcp/Authorization - name: mcp/Authorization/Protected resource discovery - name: integrations/Integrations - name: integrations/Integrations/Integration tools - name: integrations/Integrations/Integration catalog - name: integrations/Integrations/Project integrations - name: integrations/Connections - name: integrations/Connections/Connections - name: integrations/Channels - name: integrations/Channels/Channels - name: integrations/Channels/Setup lookups - name: integrations/External storage - name: integrations/External storage/External Files - name: knowledge/Documents - name: knowledge/Documents/Project knowledge - name: knowledge/Documents/Retrieval documents - name: knowledge/Search - name: knowledge/Search/Search - name: knowledge/Embeddings - name: knowledge/Embeddings/Project embeddings - name: deployments/Releases - name: deployments/Releases/Releases - name: deployments/Releases/Release Versions - name: deployments/Releases/Release Source Manifests - name: deployments/Deployments - name: deployments/Deployments/Project deployments - name: deployments/Artifacts - name: deployments/Artifacts/Dependencies - name: deployments/Artifacts/Release Asset Manifests - name: deployments/Artifacts/Style artifacts - name: runtime/Environments - name: runtime/Environments/Environments - name: runtime/Environments/Environment Domains - name: runtime/Environments/Environment variables - name: runtime/Environments/Project Domains - name: runtime/Environments/Environment Variable Keys - name: runtime/Servers - name: runtime/Servers/Environment Servers - name: runtime/Servers/Project servers - name: runtime/Sandboxes - name: runtime/Sandboxes/Sandbox Lifecycle - name: runtime/Sandboxes/Sandbox Commands - name: runtime/Sandboxes/Sandbox Environment - name: runtime/Sandboxes/Sandbox Health - name: runtime/Sandboxes/Sandbox Terminal - name: runtime/Cache - name: runtime/Cache/Project Cache - name: runtime/Cache/User Cache - name: observability/Logs - name: observability/Logs/Log entries - name: observability/Traces - name: observability/Traces/Trace spans - name: observability/Traces/Project traces - name: observability/Traces/Trace Search - name: observability/Metrics - name: observability/Metrics/Metric series - name: observability/Alerts - name: observability/Alerts/Project alerts - name: observability/Error types - name: observability/Error types/Error types - name: identity-access/Users - name: identity-access/Users/Account users - name: identity-access/Users/Project users - name: identity-access/Users/Current user - name: identity-access/Accounts - name: identity-access/Accounts/Accounts - name: identity-access/Invitations - name: identity-access/Invitations/Invitations - name: identity-access/Permissions - name: identity-access/Permissions/Feature gates - name: identity-access/Permissions/Project Ownership - name: identity-access/API keys - name: identity-access/API keys/API keys - name: identity-access/Authentication - name: identity-access/Authentication/Sign-in - name: identity-access/Authentication/Tokens - name: identity-access/Authorization - name: identity-access/Authorization/Authorized apps - name: identity-access/Authorization/General OAuth - name: identity-access/Authorization/Consent - name: billing-usage/Subscriptions - name: billing-usage/Subscriptions/Subscriptions - name: billing-usage/Subscriptions/Seats - name: billing-usage/Billing - name: billing-usage/Billing/Invoices - name: billing-usage/Billing/Payments - name: billing-usage/Billing/Payment Methods - name: billing-usage/Billing/Billing Details - name: billing-usage/Billing/Account billing - name: billing-usage/Credits - name: billing-usage/Credits/Credits - name: billing-usage/Budgets - name: billing-usage/Budgets/Budgets - name: billing-usage/Usage - name: billing-usage/Usage/API key usage - name: billing-usage/Usage/Account usage - name: billing-usage/Usage/Project usage - name: billing-usage/Analytics - name: billing-usage/Analytics/Conversation Analytics - name: billing-usage/Analytics/Run Analytics - name: platform/Other - name: platform/Other/API metadata paths: /input-requests/{input_request_id}: get: tags: - execution/Runs/Run Input Requests summary: Get input request description: Return an input request. operationId: getInputRequest parameters: - schema: type: string format: uuid required: true example: 00000000-0000-4000-8000-000000000001 name: input_request_id in: path responses: '200': description: Input request content: application/json: schema: $ref: '#/components/schemas/InputRequest' examples: example: summary: Example response value: input_request_id: 00000000-0000-4000-8000-000000000001 project_id: 00000000-0000-4000-8000-000000000001 run_id: 11111111-1111-4111-8111-111111111111 title: Approve the result fields: - name: approved type: confirm label: Approve the result? required: true status: open requested_responder_type: human response: null created_at: '2026-10-02T10:00:00Z' '400': description: Bad request content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/TargetRunProblem' - properties: status: const: 400 '401': description: Unauthorized content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/TargetRunProblem' - properties: status: const: 401 '403': description: Forbidden content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/TargetRunProblem' - properties: status: const: 403 '404': description: Not found content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/TargetRunProblem' - properties: status: const: 404 '429': description: Rate limit exceeded headers: Retry-After: schema: type: integer format: int32 minimum: 1 content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/TargetRunProblem' - properties: status: const: 429 security: - bearerAuth: [] - apiKeyAuth: [] - runExecutionAuth: [] components: schemas: InputRequest: type: object properties: input_request_id: type: string format: uuid description: Unique input request ID. project_id: type: string format: uuid description: Project inherited from the run. run_id: type: string format: uuid description: Run waiting for this input. title: type: string minLength: 1 maxLength: 1000 description: Question or decision shown to the responder. fields: type: array items: $ref: '#/components/schemas/InputRequestField' description: Fields the responder can fill in. status: type: string enum: - open - submitted - cancelled - expired description: Current resolution state. requested_responder_type: type: string enum: - human - agent - system description: >- Required responder role; the authenticated actor identifies who actually responded. response: anyOf: - $ref: '#/components/schemas/InputResponse' - type: 'null' - type: 'null' description: >- Submitted response, or null before submission or after cancellation or expiry. created_at: type: string format: date-time description: When the request was created. expires_at: type: string format: date-time description: When the request expires. resolved_at: type: string format: date-time description: When the request was submitted, cancelled or expired. tool_call_id: type: string minLength: 1 maxLength: 128 description: Tool invocation waiting for the response. conversation_id: type: string format: uuid description: Conversation inherited from the run. description: type: string description: Additional instructions for the responder. metadata: type: object additionalProperties: description: A JSON value. description: Additional resource metadata. required: - input_request_id - project_id - run_id - title - fields - status - requested_responder_type - response - created_at allOf: - if: properties: status: enum: - submitted required: - status then: properties: response: type: object else: properties: response: type: 'null' - if: properties: status: enum: - open required: - status then: not: required: - resolved_at else: required: - resolved_at TargetRunProblem: type: object properties: type: type: string description: Problem type URI reference. title: type: string status: type: integer minimum: 400 maximum: 599 format: int64 code: type: string minLength: 1 maxLength: 128 cause: type: string enum: - schedule_concurrency_forbidden - schedule_fire_in_progress - schedule_run_limit_reached description: Schedule admission refusal. detail: type: string instance: type: string errors: type: array items: type: object properties: field: type: string message: type: string required: - field - message required: - type - title - status - code InputRequestField: anyOf: - type: object properties: name: type: string minLength: 1 maxLength: 128 label: type: string maxLength: 1000 description: type: string maxLength: 4000 required: type: boolean default: false type: type: string enum: - password required: - name - type additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 128 label: type: string maxLength: 1000 description: type: string maxLength: 4000 required: type: boolean default: false type: type: string enum: - text - textarea - email - url default: type: string required: - name - type additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 128 label: type: string maxLength: 1000 description: type: string maxLength: 4000 required: type: boolean default: false type: type: string enum: - number default: type: number required: - name - type additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 128 label: type: string maxLength: 1000 description: type: string maxLength: 4000 required: type: boolean default: false type: type: string enum: - checkbox - confirm default: type: boolean required: - name - type additionalProperties: false - type: object properties: name: type: string minLength: 1 maxLength: 128 label: type: string maxLength: 1000 description: type: string maxLength: 4000 required: type: boolean default: false type: type: string enum: - select - radio options: type: array items: type: object properties: value: type: string minLength: 1 label: type: string minLength: 1 description: type: string recommended: type: boolean required: - value - label additionalProperties: false minItems: 1 maxItems: 100 default: type: string required: - name - type - options additionalProperties: false InputResponse: type: object properties: response_id: type: string format: uuid description: Unique response ID. values: $ref: '#/components/schemas/InputValues' actor: anyOf: - $ref: '#/components/schemas/Actor' - $ref: '#/components/schemas/UnavailableActor' description: >- Authenticated principal that submitted the response, or `unavailable` for a historical response without authoritative provenance. redacted_fields: type: array items: type: string minLength: 1 maxLength: 128 description: Names of submitted secret fields omitted from values. created_at: type: string format: date-time description: When the response was submitted. required: - response_id - values - actor - created_at InputValues: type: object additionalProperties: anyOf: - type: string - type: number - type: boolean - type: 'null' - type: 'null' description: >- Submitted values keyed by field name; password values are omitted from reads. x-ref-description: >- Submitted values keyed by field name; password values are omitted from reads. Actor: type: object properties: type: type: string enum: - user - api_key - service_account - system id: type: string minLength: 1 maxLength: 128 required: - type - id description: >- Immediate authenticated initiator, recorded by the server; execution credentials identify their issuing service account, not the original caller. UnavailableActor: type: object properties: type: type: string enum: - unavailable reason: type: string enum: - not_recorded - identity_removed description: >- `not_recorded`: the server never stored the submitting credential. `identity_removed`: the recorded identity was later revoked or deleted. legacy_role: type: string enum: - human - agent - integration - system - user - api_key - service_account description: >- Role tag stored with the response. It is not an authenticated actor type. legacy_id: type: string minLength: 1 maxLength: 255 description: >- Actor ID stored with the response. It is not promoted to an authenticated actor. required: - type - reason additionalProperties: false description: >- A historical response without authoritative submitting-credential provenance. The server never infers or looks up a replacement actor. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT or API Key description: >- Use a JWT bearer token or a Veryfront API key in the `Authorization` header. apiKeyAuth: type: apiKey in: header name: X-API-Key description: Alternative API key header for `vf__` tokens. runExecutionAuth: type: http scheme: bearer bearerFormat: JWT description: >- Server-issued credential bound to project, run, registered runtime, execution generation, audience, expiry, and explicitly allowed operations; user/API-key editor access is insufficient. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.