Stedi Executions API

openapi: 3.2.0
info:
  title: Core Executions API
  version: '2023-08-01'
  contact:
    email: core@stedi.com
  license:
    name: Proprietary
    url: https://stedi.com
servers:
- url: https://core.us.stedi.com/2023-08-01
  description: Production
security:
- httpApiKeyAuth: []
tags:
- name: Executions
paths:
  /executions:
    get:
      description: Fetch a list of executions, sorted by the date they were created from newest to oldest.
      operationId: ListExecutions
      parameters:
      - name: pageSize
        in: query
        description: The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100.
        schema:
          type: number
          minimum: 1
          description: The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100.
        examples:
          ListExecutions_example1:
            summary: List executions
            description: ''
            value: 200
      - name: pageToken
        in: query
        description: An opaque token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results.
        schema:
          type: string
          maxLength: 1024
          minLength: 1
          description: An opaque token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results.
      - name: direction
        in: query
        description: The direction of the transaction. Inbound transactions are those you receive from a payer, provider, or other trading partner. Outbound transactions are those you send to a payer, provider, or other trading partner.
        schema:
          $ref: '#/components/schemas/Direction'
      - name: faultCode
        in: query
        description: A code specifying the reason for the fault. This code appears in the `code` property of the HTTP error response.
        schema:
          $ref: '#/components/schemas/ExecutionFaultCode'
      - name: partnershipId
        in: query
        description: The unique identifier for the partnership within the Stedi platform. If you're sending or receiving transactions through the Stedi clearinghouse, Stedi configures the necessary partnership for you automatically when you set up your account.
        schema:
          type: string
          description: The unique identifier for the partnership within the Stedi platform. If you're sending or receiving transactions through the Stedi clearinghouse, Stedi configures the necessary partnership for you automatically when you set up your account.
      - name: status
        in: query
        description: "The status of the execution.\n  - You can only retry executions with a `FAILED` or `IGNORED` status.\n  - An execution is `COMPLETED` when Stedi has finished processing the file with no errors. If the file is an outbound file, a `COMPLETED` status also means that Stedi successfully delivered it to the configured connection."
        schema:
          $ref: '#/components/schemas/ExecutionStatus'
      - name: from
        in: query
        description: The start of the time range to filter file executions. The results will include executions created at or after this timestamp.
        schema:
          type: string
          description: The start of the time range to filter file executions. The results will include executions created at or after this timestamp.
          format: date-time
      - name: to
        in: query
        description: The end of the time range to filter file executions. The results will include executions up to and including this timestamp.
        schema:
          type: string
          description: The end of the time range to filter file executions. The results will include executions up to and including this timestamp.
          format: date-time
      - name: displayName
        in: query
        description: Filter executions by the source of the file, including the directory and file name. Supports partial matching against the full path.
        schema:
          type: string
          minLength: 3
          description: Filter executions by the source of the file, including the directory and file name. Supports partial matching against the full path.
      responses:
        '200':
          description: ListExecutions 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListExecutionsResponseContent'
              examples:
                ListExecutions_example1:
                  summary: List executions
                  description: ''
                  value:
                    items:
                    - createdAt: '2025-04-04T17:14:35.481Z'
                      direction: INBOUND
                      executionId: 55907f88-999e-4912-9e9b-78326f8bade8
                      faultCount: 0
                      partnershipId: local-clearinghouse-test
                      source:
                        dirname: .
                        name: test-inbound-ingest-30848232-fa0c-4151-8217-d03205e806f9.edi
                      retryable: true
                      status: COMPLETED
                      transactionCount: 1
                      updatedAt: '2025-04-04T17:14:42.854Z'
                    - createdAt: '2025-04-02T21:30:08.387Z'
                      direction: INBOUND
                      executionId: 95236a56-a020-4522-8fef-bcffcec0ec1d
                      faultCount: 0
                      partnershipId: local-clearinghouse-test
                      source:
                        dirname: .
                        name: test-inbound-ingest-3f2efd94-2a81-4b57-b4de-9b970a50db60.edi
                      retryable: true
                      status: COMPLETED
                      transactionCount: 1
                      updatedAt: '2025-04-02T21:30:16.185Z'
                    - createdAt: '2025-02-28T19:16:26.041Z'
                      direction: OUTBOUND
                      executionId: 06bdccdc-4ab9-4add-b1dc-a76a0183f299
                      faultCount: 0
                      partnershipId: local-clearinghouse-test
                      source:
                        dirname: f894c51a-14639/to-stedi
                        name: 837-clearinghouse_outbound.edi
                      retryable: true
                      status: COMPLETED
                      transactionCount: 1
                      updatedAt: '2025-02-28T19:16:27.706Z'
                    nextPageToken: eyJwYWdlIjoxLCJwYWdlU2l6ZSI6MTAsInBhZ2VUb3RhbCI6MzE0fQ==
        '400':
          description: BadRequestException 400 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestExceptionResponseContent'
        '401':
          description: UnauthorizedException 401 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
        '403':
          description: AccessDeniedException 403 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
        '404':
          description: ResourceNotFoundException 404 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
        '409':
          description: ResourceUnderChangeException 409 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
        '422':
          description: UnprocessableEntityException 422 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
        '429':
          description: ThrottlingException 429 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingExceptionResponseContent'
        '500':
          description: ServiceException 500 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceExceptionResponseContent'
        '503':
          description: ServiceUnavailableException 503 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
        '504':
          description: GatewayTimeoutException 504 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
      tags:
      - Executions
  /executions/retry:
    post:
      description: Queue file executions to be retried.
      operationId: RetryExecutions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetryExecutionsRequestContent'
            examples:
              RetryExecutions_example1:
                summary: Retry executions
                description: ''
                value:
                  condition:
                    status: FAILED
                    from: '2025-02-10T00:00:00Z'
                    to: '2025-02-12T23:59:59Z'
        required: true
      responses:
        '200':
          description: RetryExecutions 200 response
        '400':
          description: BadRequestException 400 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestExceptionResponseContent'
        '401':
          description: UnauthorizedException 401 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
        '403':
          description: AccessDeniedException 403 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
        '404':
          description: ResourceNotFoundException 404 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
        '409':
          description: ResourceUnderChangeException 409 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
        '422':
          description: UnprocessableEntityException 422 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
        '429':
          description: ThrottlingException 429 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingExceptionResponseContent'
        '500':
          description: ServiceException 500 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceExceptionResponseContent'
        '503':
          description: ServiceUnavailableException 503 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
        '504':
          description: GatewayTimeoutException 504 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
      tags:
      - Executions
  /executions/{executionId}:
    get:
      description: Retrieve the file execution details for a given `executionId`.
      operationId: GetExecution
      parameters:
      - name: executionId
        in: path
        description: A unique identifier for the file execution within Stedi. This ID is included in the file processed event, or you can retrieve it manually from the file's details page within the Stedi portal.
        schema:
          type: string
          description: A unique identifier for the file execution within Stedi. This ID is included in the file processed event, or you can retrieve it manually from the file's details page within the Stedi portal.
        required: true
        examples:
          GetExecution_example1:
            summary: Get execution
            description: ''
            value: b1356ef2-a10d-482a-b2db-408f1d5e7ff5
      responses:
        '200':
          description: GetExecution 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExecutionResponseContent'
              examples:
                GetExecution_example1:
                  summary: Get execution
                  description: ''
                  value:
                    artifacts:
                    - artifactType: application/edi-x12
                      sizeBytes: 751
                      model: execution
                      usage: input
                      url: https://core.us.stedi.com/2023-08-01/executions/b1356ef2-a10d-482a-b2db-408f1d5e7ff5/input
                    - artifactType: application/json
                      sizeBytes: 1024
                      model: execution
                      usage: metadata
                      url: https://core.us.stedi.com/2023-08-01/executions/b1356ef2-a10d-482a-b2db-408f1d5e7ff5/metadata
                    connectionId: 01J8JH26KBJTARWD17Q0S0ZD19
                    connectionType: BUCKET
                    createdAt: '2025-02-12T22:21:08.815Z'
                    direction: INBOUND
                    executionId: b1356ef2-a10d-482a-b2db-408f1d5e7ff5
                    faultCount: 0
                    partnershipId: local-clearinghouse-test
                    source:
                      dirname: clearinghouse/incoming
                      name: 7a79135a-73ae-427b-b762-9d4d437d4aab.x12
                    retryable: false
                    status: COMPLETED
                    transactionCount: 1
                    updatedAt: '2025-02-12T22:21:15.839Z'
        '400':
          description: BadRequestException 400 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestExceptionResponseContent'
        '401':
          description: UnauthorizedException 401 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
        '403':
          description: AccessDeniedException 403 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
        '404':
          description: ResourceNotFoundException 404 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
        '409':
          description: ResourceUnderChangeException 409 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
        '422':
          description: UnprocessableEntityException 422 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
        '429':
          description: ThrottlingException 429 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingExceptionResponseContent'
        '500':
          description: ServiceException 500 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceExceptionResponseContent'
        '503':
          description: ServiceUnavailableException 503 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
        '504':
          description: GatewayTimeoutException 504 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
      tags:
      - Executions
  /executions/{executionId}/faults:
    get:
      description: Fetch a list of faults for a given file execution, sorted by the date they were created from newest to oldest.
      operationId: ListExecutionFaults
      parameters:
      - name: executionId
        in: path
        description: A unique identifier for the file execution within Stedi. This ID is included in the file processed event, or you can retrieve it manually from the file's details page within the Stedi portal.
        schema:
          type: string
          description: A unique identifier for the file execution within Stedi. This ID is included in the file processed event, or you can retrieve it manually from the file's details page within the Stedi portal.
        required: true
        examples:
          ListExecutionFaults_example1:
            summary: List execution faults
            description: ''
            value: b1356ef2-a10d-482a-b2db-408f1d5e7ff5
      - name: pageSize
        in: query
        description: The maximum number of elements to return in a page. If not specified, the default is 100.
        schema:
          type: number
          maximum: 500
          minimum: 1
          description: The maximum number of elements to return in a page. If not specified, the default is 100.
        examples:
          ListExecutionFaults_example1:
            summary: List execution faults
            description: ''
            value: 100
      - name: pageToken
        in: query
        description: '`pageToken` is an opaque token returned by a previous call to this operation in the `nextPageToken`'
        schema:
          type: string
          maxLength: 1024
          minLength: 1
          description: '`pageToken` is an opaque token returned by a previous call to this operation in the `nextPageToken`'
      responses:
        '200':
          description: ListExecutionFaults 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListExecutionFaultsResponseContent'
              examples:
                ListExecutionFaults_example1:
                  summary: List execution faults
                  description: ''
                  value:
                    items:
                    - id: abcd1234-ab12-cd34-b2db-408f1d5e7ff5
                      executionId: b1356ef2-a10d-482a-b2db-408f1d5e7ff5
                      faultCode: FAILED_TO_TRANSLATE
                      faultMessage: String element NM1-09 length must be between 2 and 80, actual length is 96
                      guideId: 01JE924V5MK7B9X6KBGPWPDZ0W
                      receiverProfile:
                        applicationId: ACME
                        profileId: acme
                        profileType: local
                        interchangeQualifier: ZZ
                        interchangeId: ACME
                      senderProfile:
                        applicationId: STEDITEST
                        profileId: clearinghouse-test
                        profileType: partner
                        interchangeQualifier: ZZ
                        interchangeId: STEDITEST
                      translateFaultContext:
                        mark:
                          end:
                            line: 3
                            column: 145
                          start:
                            line: 3
                            column: 49
                        context:
                          code: data_element_too_long
                          lineage:
                            loop_id: 1000A
                            segment_id: NM1
                            element_pos: 09
                          schema_path: properties.heading.properties.submitter_name_NM1_loop.properties.submitter_name_NM1.properties.submitter_identifier_09
                          segment_index: 3
                          element_refnum: '67'
                      transactionSetIdentifier: '837'
                      release: 005010X222A1
                      createdAt: '2025-06-01T00:00:00.000Z'
                      artifacts:
                      - artifactType: application/edi-x12
                        sizeBytes: 1397
                        model: fault
                        usage: input
                        url: https://core.us.stedi.com/2023-08-01/executions/b1356ef2-a10d-482a-b2db-408f1d5e7ff5/faults/abcd1234-ab12-cd34-b2db-408f1d5e7ff5/input
        '400':
          description: BadRequestException 400 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestExceptionResponseContent'
        '401':
          description: UnauthorizedException 401 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
        '403':
          description: AccessDeniedException 403 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
        '404':
          description: ResourceNotFoundException 404 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
        '409':
          description: ResourceUnderChangeException 409 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
        '422':
          description: UnprocessableEntityException 422 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
        '429':
          description: ThrottlingException 429 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingExceptionResponseContent'
        '500':
          description: ServiceException 500 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceExceptionResponseContent'
        '503':
          description: ServiceUnavailableException 503 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
        '504':
          description: GatewayTimeoutException 504 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
      tags:
      - Executions
  /executions/{executionId}/input:
    get:
      description: Fetch a file execution's input document before any translation and mappings.
      operationId: GetExecutionInputDocument
      parameters:
      - name: executionId
        in: path
        description: A unique identifier for the file execution within Stedi. This ID is included in the file processed event, or you can retrieve it manually from the file's details page within the Stedi portal.
        schema:
          type: string
          description: A unique identifier for the file execution within Stedi. This ID is included in the file processed event, or you can retrieve it manually from the file's details page within the Stedi portal.
        required: true
        examples:
          GetExecutionInputDocument_example1:
            summary: Get execution input document
            description: ''
            value: 06bdccdc-4aaa-4aaa-4aaa-abaa11110000
      responses:
        '302':
          description: GetExecutionInputDocument 302 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExecutionInputDocumentResponseContent'
              examples:
                GetExecutionInputDocument_example1:
                  summary: Get execution input document
                  description: ''
                  value:
                    documentDownloadUrl: https://stedi-default-core-artifacts.s3.us-east-1.amazonaws.com/write/input/06bdccdc-4aaa-4aaa...
        '400':
          description: BadRequestException 400 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestExceptionResponseContent'
        '401':
          description: UnauthorizedException 401 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
        '403':
          description: AccessDeniedException 403 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
        '404':
          description: ResourceNotFoundException 404 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
        '409':
          description: ResourceUnderChangeException 409 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
        '422':
          description: UnprocessableEntityException 422 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
        '429':
          description: ThrottlingException 429 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingExceptionResponseContent'
        '500':
          description: ServiceException 500 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceExceptionResponseContent'
        '503':
          description: ServiceUnavailableException 503 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
        '504':
          description: GatewayTimeoutException 504 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
      tags:
      - Executions
  /executions/{executionId}/input-url:
    get:
      description: This endpoint is used to retrieve an execution's input document before it passes through any translation and mappings. Generally, this will be EDI. This endpoint returns the document download URL, it must be then fetched for the actual document content. There are no size restrictions on documents when fetching from this endpoint.
      operationId: GetExecutionInputDocumentUrl
      parameters:
      - name: executionId
        in: path
        schema:
          type: string
        required: true
        examples:
          GetExecutionInputDocumentUrl_example1:
            summary: Get execution input document url
            description: ''
            value: 06bdccdc-4aaa-4aaa-4aaa-abaa11110000
      responses:
        '200':
          description: GetExecutionInputDocumentUrl 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExecutionInputDocumentUrlResponseContent'
              examples:
                GetExecutionInputDocumentUrl_example1:
                  summary: Get execution input document url
                  description: ''
                  value:
                    documentDownloadUrl: https://stedi-default-core-artifacts.s3.us-east-1.amazonaws.com/write/input/06bdccdc-4aaa-4aaa...
        '400':
          description: BadRequestException 400 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestExceptionResponseContent'
        '401':
          description: UnauthorizedException 401 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
        '403':
          description: AccessDeniedException 403 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
        '404':
          description: ResourceNotFoundException 404 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
        '409':
          description: ResourceUnderChangeException 409 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
        '422':
          description: UnprocessableEntityException 422 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
        '429':
          description: ThrottlingException 429 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingExceptionResponseContent'
        '500':
          description: ServiceException 500 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceExceptionResponseContent'
        '503':
          description: ServiceUnavailableException 503 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
        '504':
          description: GatewayTimeoutException 504 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
      tags:
      - Executions
  /executions/{executionId}/metadata:
    get:
      description: Fetch a file execution's metadata document.
      operationId: GetExecutionMetadataDocument
      parameters:
      - name: executionId
        in: path
        description: A unique identifier for the file execution within Stedi. This ID is included in the file processed event, or you can retrieve it manually from the file's details page within the Stedi portal.
        schema:
          type: string
          description: A unique identifier for the file execution within Stedi. This ID is included in the file processed event, or you can retrieve it manually from the file's details page within the Stedi portal.
        required: true
        examples:
          GetExecutionMetadataDocument_example1:
            summary: Get execution metadata document
            description: ''
            value: 06bdccdc-baa1-baa1-b111-a76a11110000
      responses:
        '302':
          description: GetExecutionMetadataDocument 302 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExecutionMetadataDocumentResponseContent'
              examples:
                GetExecutionMetadataDocument_example1:
                  summary: Get execution metadata document
                  description: ''
                  value:
                    documentDownloadUrl: https://stedi-default-core-artifacts.s3.us-east-1.

# --- truncated at 32 KB (92 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stedi/refs/heads/main/openapi/stedi-executions-api-openapi.yml