> ## Documentation Index
> Fetch the complete documentation index at: https://docs.edges.run/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Run Inputs
> Retrieve the inputs submitted to a run and the per-input status, to see which succeeded and which failed.
`uid` is used for all the endpoints and Run manipulation.
The `id` is an internal identifier returned to smooth and improve speed and accuracy if you have questions about your runs you will want
to submit to the team.
## Overview
The `GET /runs/{run_uid}/inputs` endpoint returns the complete list of inputs associated with a run, including their execution status and any associated errors. This endpoint is essential for recovering detailed input-level results and errors, especially when webhook callbacks are missed or need to be verified.
## Pagination
This endpoint uses **cursor-based pagination** by default. Follow the `X-Pagination-Next` response header to retrieve subsequent pages.
* `limit` controls the page size (default: **100**, max: **500**).
* The `X-Pagination-Next` header contains the **full URL** for the next page, including `limit` and `cursor`.
* When the `X-Pagination-Next` header is **absent**, there are no more pages.
The `offset` parameter is **deprecated**. If provided, the system falls back to offset-based pagination and cursor pagination is not used. Prefer following the `X-Pagination-Next` URL for all new integrations.
## OpenAPI
````yaml v1/api/actions.json get /runs/{run_uid}/inputs
openapi: 3.1.0
info:
title: ED Automation External API
description: This is the External API documentation for ED Automation
version: dev
servers:
- url: https://api.edges.run/v1
security:
- XApiKeyAuth: []
paths:
/runs/{run_uid}/inputs:
get:
tags:
- public / runs
summary: Get inputs by Run UUID
operationId: getRunInputs
parameters:
- schema:
type: integer
minimum: 1
maximum: 500
default: 100
in: query
name: limit
required: false
description: Number of inputs to return
- schema:
type:
- integer
- 'null'
minimum: 0
default: null
deprecated: true
in: query
name: offset
required: false
description: (deprecated) Number of inputs to skip for pagination
- schema:
type: string
title: Pagination Cursor
in: query
name: cursor
required: false
description: >-
(optional) Cursor value obtained from the `X-Pagination-Next`
response header of a previous request, used to continue pagination.
If not provided, the first page will be returned.
- schema:
type: string
format: uuid
in: path
name: run_uid
required: true
description: Run UUID
responses:
'200':
description: Returns the run inputs
headers:
X-Pagination-Next:
schema:
title: Next Page URL
type: string
description: >-
URL to retrieve the next page of results. If present, indicates
that there are more results to fetch. This URL includes the
necessary query parameters (like cursor) to get the next set of
outputs.
content:
application/json:
schema:
description: Returns the run inputs
type: array
items:
type: object
description: Run Input
properties:
uid:
type: string
format: uuid
description: Unique identifier for the input.
status:
type:
- string
- 'null'
enum:
- CREATED
- QUEUED
- SCHEDULED
- RUNNING
- BLOCKED
- FAILED
- SUCCEEDED
- STOPPED
description: Current status of the input.
input_data:
type: object
description: Input payload.
additionalProperties: true
custom_data:
type:
- object
- 'null'
description: Custom metadata or additional information.
additionalProperties: true
last_error:
type:
- object
- 'null'
description: Information about the last execution attempt.
properties:
has_failed:
type:
- boolean
- 'null'
description: Indicates if the last run failed.
message:
type:
- string
- 'null'
description: Error or status message from the last run.
scope:
type:
- string
- 'null'
enum:
- input
- integ
- config
- param
description: Scope of the error if any occurred.
label:
type:
- string
- 'null'
description: Label describing the error or status.
error_ref:
type:
- string
- 'null'
description: Reference code for the error.
params:
type:
- object
- 'null'
description: Parameters related to the error.
additionalProperties:
type: string
validation_errors:
type:
- object
- 'null'
description: Validation errors encountered during the last run.
additionalProperties: true
additionalProperties: false
last_info:
type:
- object
- 'null'
description: Information about the last execution attempt.
properties:
has_failed:
type:
- boolean
- 'null'
description: Indicates if the last run failed.
message:
type:
- string
- 'null'
description: Error or status message from the last run.
scope:
type:
- string
- 'null'
enum:
- input
- integ
- config
- param
description: Scope of the error if any occurred.
label:
type:
- string
- 'null'
description: Label describing the error or status.
error_ref:
type:
- string
- 'null'
description: Reference code for the error.
params:
type:
- object
- 'null'
description: Parameters related to the error.
additionalProperties:
type: string
validation_errors:
type:
- object
- 'null'
description: Validation errors encountered during the last run.
additionalProperties: true
additionalProperties: false
output_count:
type: integer
description: Number of outputs generated by the input.
retry_count:
type:
- integer
- 'null'
description: Number of retry attempts for the input.
started_at:
type:
- string
- 'null'
description: Timestamp when the input started.
finished_at:
type:
- string
- 'null'
description: Timestamp when the input finished.
created_at:
type: string
description: Timestamp when the input was created.
updated_at:
type:
- string
- 'null'
description: Timestamp when the input was last updated.
additionalProperties: false
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/def-0'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/def-0'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/def-0'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/def-0'
components:
schemas:
def-0:
title: APIError
description: >-
Represents an error returned by the API. This schema defines the
standard structure of error messages to ensure consistent error handling
across the application.
type: object
properties:
error_label:
type:
- string
- 'null'
error_scope:
type:
- string
- 'null'
enum:
- input
- integ
- param
- config
error_ref:
type:
- string
- 'null'
examples:
- ERR-12345
message:
type: string
status_code:
type:
- integer
- 'null'
params:
type:
- object
- 'null'
additionalProperties:
anyOf:
- type: string
- type: number
- type: boolean
- type: 'null'
- type: array
items:
type: string
data:
type:
- object
- 'null'
additionalProperties: true
description: Additional data about the error
additionalProperties: false
securitySchemes:
XApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.