Everyn Exports API

Self-starting CSV exports. Clients create, poll/list/read, and download ready exports through the API; there is no public execute action.

GitHub OpenAPI

Operations 5

GET /v1/exports List Exports #
GET /v1/exports/{export_id} Get Export #
GET /v1/exports/{export_id}/download Download Export #
GET /v1/runs/{run_id}/exports List Run Exports #
POST /v1/runs/{run_id}/exports Create Export #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/everyn-ai:everyn-ai-exports-api"
All apis
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.

Get an API 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 Specification

everyn-ai-exports-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: 'everyn self-serve API for dataset upload sessions, job specs, managed runs, run inspection, retry lineage, exports, alerts, webhooks, model catalog reads, usage and managed-AI balance reads, and organization administration.


    API routes use the `/v1` prefix. API-key product calls use `Authorization: Bearer sk-everyn-...` and derive organization context from the key. Job creation, editing and forking require a human browser session and CSRF protection; product API keys may read and run saved jobs but cannot author them. Browser-admin organization routes use bearer credentials and organization IDs in the route. Successful list responses use `{ "data": [], "nextCursor": null }`, and every response includes `X-Request-Id`.'
  title: everyn Public Exports API
  version: 1.0.0
servers:
- description: Production API
  url: https://api.everyn.ai
- description: Local development API
  url: http://localhost:8000
tags:
- description: Self-starting CSV exports. Clients create, poll/list/read, and download ready exports through the API; there is no public execute action.
  name: Exports
paths:
  /v1/exports:
    get:
      description: 'List Exports. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.'
      operationId: list_exports_v1_exports_get
      parameters:
      - description: Maximum number of items to return in this page.
        in: query
        name: limit
        required: false
        schema:
          default: 50
          title: Limit
          type: integer
      - description: Opaque pagination cursor from the previous page.
        in: query
        name: cursor
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      - description: Identifier of the run.
        in: query
        name: runId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Runid
      - description: status for this Everyn API operation.
        in: query
        name: status
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          enum:
          - expired
          - failed
          - generating
          - queued
          - ready
          title: Status
      - description: type for this Everyn API operation.
        in: query
        name: type
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          enum:
          - all_rows
          - failed_rows
          - flagged_rows
          - generated_outputs
          - resolved_lineage_results
          - successful_rows
          title: Type
      - description: format for this Everyn API operation.
        in: query
        name: format
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          enum:
          - csv
          title: Format
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_ExportResponse_'
          description: Successful Response
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Malformed request, header, cursor, or multipart form field.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Missing, malformed, unknown, revoked, or expired credential.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Authenticated principal lacks the required scope or role.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Resource not found, including cross-organization resources.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Idempotency conflict or invalid resource state.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Public error
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Rate limit exceeded.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
      security:
      - BearerAuth: []
      summary: List Exports
      tags:
      - Exports
  /v1/exports/{export_id}:
    get:
      description: 'Get Export. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.'
      operationId: get_export_v1_exports__export_id__get
      parameters:
      - description: export_id for this Everyn API operation.
        in: path
        name: export_id
        required: true
        schema:
          title: Export Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportResponse'
          description: Successful Response
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Malformed request, header, cursor, or multipart form field.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Missing, malformed, unknown, revoked, or expired credential.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Authenticated principal lacks the required scope or role.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Resource not found, including cross-organization resources.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Idempotency conflict or invalid resource state.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Public error
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Rate limit exceeded.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
      security:
      - BearerAuth: []
      summary: Get Export
      tags:
      - Exports
  /v1/exports/{export_id}/download:
    get:
      description: 'Download Export. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.'
      operationId: download_export_v1_exports__export_id__download_get
      parameters:
      - description: export_id for this Everyn API operation.
        in: path
        name: export_id
        required: true
        schema:
          title: Export Id
          type: string
      responses:
        '200':
          content:
            text/csv:
              schema:
                format: binary
                type: string
          description: CSV export artifact
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Malformed request, header, cursor, or multipart form field.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Missing, malformed, unknown, revoked, or expired credential.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Authenticated principal lacks the required scope or role.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Resource not found, including cross-organization resources.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Idempotency conflict or invalid resource state.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '410':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Export artifact has expired.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Public error
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Rate limit exceeded.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
      security:
      - BearerAuth: []
      summary: Download Export
      tags:
      - Exports
  /v1/runs/{run_id}/exports:
    get:
      description: 'List Run Exports. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.'
      operationId: list_run_exports_v1_runs__run_id__exports_get
      parameters:
      - description: Identifier of the run.
        in: path
        name: run_id
        required: true
        schema:
          title: Run Id
          type: string
      - description: Maximum number of items to return in this page.
        in: query
        name: limit
        required: false
        schema:
          default: 50
          title: Limit
          type: integer
      - description: Opaque pagination cursor from the previous page.
        in: query
        name: cursor
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      - description: status for this Everyn API operation.
        in: query
        name: status
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          enum:
          - expired
          - failed
          - generating
          - queued
          - ready
          title: Status
      - description: type for this Everyn API operation.
        in: query
        name: type
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          enum:
          - all_rows
          - failed_rows
          - flagged_rows
          - generated_outputs
          - resolved_lineage_results
          - successful_rows
          title: Type
      - description: format for this Everyn API operation.
        in: query
        name: format
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          enum:
          - csv
          title: Format
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_ExportResponse_'
          description: Successful Response
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Malformed request, header, cursor, or multipart form field.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Missing, malformed, unknown, revoked, or expired credential.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Authenticated principal lacks the required scope or role.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Resource not found, including cross-organization resources.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Idempotency conflict or invalid resource state.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Public error
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Rate limit exceeded.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
      security:
      - BearerAuth: []
      summary: List Run Exports
      tags:
      - Exports
    post:
      description: 'Create Export. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.'
      operationId: create_export_v1_runs__run_id__exports_post
      parameters:
      - description: Identifier of the run.
        in: path
        name: run_id
        required: true
        schema:
          title: Run Id
          type: string
      - description: Caller-supplied key that makes this write retry-safe.
        in: header
        name: Idempotency-Key
        required: true
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Idempotency-Key
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportCreateRequestBody'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportResponse'
          description: Successful Response
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Malformed request, header, cursor, or multipart form field.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Missing, malformed, unknown, revoked, or expired credential.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Authenticated principal lacks the required scope or role.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Resource not found, including cross-organization resources.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Idempotency conflict or invalid resource state.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Public error
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
          description: Rate limit exceeded.
          headers:
            X-Request-Id:
              description: Canonical everyn request ID generated by the API.
              schema:
                examples:
                - req_abc123
                type: string
      security:
      - BearerAuth: []
      summary: Create Export
      tags:
      - Exports
components:
  schemas:
    ExportCreateRequestBody:
      additionalProperties: false
      properties:
        fileName:
          default: result.csv
          maxLength: 128
          title: Filename
          type: string
        format:
          const: csv
          title: Format
          type: string
        type:
          enum:
          - all_rows
          - successful_rows
          - failed_rows
          - flagged_rows
          - generated_outputs
          - resolved_lineage_results
          title: Type
          type: string
      required:
      - type
      - format
      title: ExportCreateRequestBody
      type: object
    ExportResponse:
      additionalProperties: false
      properties:
        completedAt:
          anyOf:
          - description: UTC RFC 3339 timestamp string.
            examples:
            - '2026-06-12T12:00:00Z'
            type: string
          - type: 'null'
          title: Completedat
        createdAt:
          anyOf:
          - description: UTC RFC 3339 timestamp string.
            examples:
            - '2026-06-12T12:00:00Z'
            type: string
          - type: 'null'
          title: Createdat
        downloadReady:
          title: Downloadready
          type: boolean
        downloadUrl:
          title: Downloadurl
          type: string
        downloadUrlExpiresAt:
          anyOf:
          - description: UTC RFC 3339 timestamp string.
            examples:
            - '2026-06-12T12:00:00Z'
            type: string
          - type: 'null'
          title: Downloadurlexpiresat
        expiresAt:
          anyOf:
          - description: UTC RFC 3339 timestamp string.
            examples:
            - '2026-06-12T12:00:00Z'
            type: string
          - type: 'null'
          title: Expiresat
        failure:
          anyOf:
          - {}
          - type: 'null'
          title: Failure
        format:
          const: csv
          title: Format
          type: string
        id:
          minLength: 1
          title: Id
          type: string
        mcpCreation:
          anyOf:
          - $ref: '#/components/schemas/McpCreationResponse'
          - type: 'null'
        runId:
          minLength: 1
          title: Runid
          type: string
        status:
          enum:
          - queued
          - generating
          - ready
          - failed
          - expired
          title: Status
          type: string
        type:
          enum:
          - all_rows
          - successful_rows
          - failed_rows
          - flagged_rows
          - generated_outputs
          - resolved_lineage_results
          title: Type
          type: string
      required:
      - id
      - runId
      - type
      - format
      - status
      - downloadReady
      - downloadUrl
      - downloadUrlExpiresAt
      - failure
      - completedAt
      - expiresAt
      - createdAt
      title: ExportResponse
      type: object
    Page_ExportResponse_:
      additionalProperties: false
      properties:
        data:
          items:
            $ref: '#/components/schemas/ExportResponse'
          title: Data
          type: array
        nextCursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Nextcursor
      required:
      - data
      title: Page[ExportResponse]
      type: object
    PublicError:
      additionalProperties: false
      properties:
        code:
          type: string
        details:
          additionalProperties: true
          type: object
        docsUrl:
          format: uri
          type: string
        fieldErrors:
          items:
            $ref: '#/components/schemas/PublicFieldError'
          type: array
        message:
          type: string
        requestId:
          type: string
        status:
          type: integer
      required:
      - status
      - code
      - message
      - requestId
      - docsUrl
      - fieldErrors
      type: object
    McpCreationResponse:
      additionalProperties: false
      description: 'Smallest safe MCP attribution for product reads.


        Server-derived only. Omits grant id, actor id, organization id, role,

        scopes, tokens, and raw OAuth identifiers.'
      properties:
        channel:
          const: mcp
          title: Channel
          type: string
        clientId:
          anyOf:
          - type: string
          - type: 'null'
          title: Clientid
        principalType:
          enum:
          - workos_jwt
          - api_key
          title: Principaltype
          type: string
      required:
      - channel
      - principalType
      title: McpCreationResponse
      type: object
    PublicErrorEnvelope:
      additionalProperties: false
      properties:
        error:
          $ref: '#/components/schemas/PublicError'
      required:
      - error
      type: object
    PublicFieldError:
      additionalProperties: false
      properties:
        actual: {}
        code:
          type: string
        expected: {}
        message:
          type: string
        source:
          $ref: '#/components/schemas/PublicFieldErrorSource'
      required:
      - source
      - code
      - message
      type: object
    PublicFieldErrorSource:
      additionalProperties: false
      minProperties: 1
      properties:
        formField:
          type: string
        header:
          type: string
        parameter:
          type: string
        pointer:
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      scheme: bearer
      type: http
    BrowserCsrf:
      description: csrfToken returned by GET /v1/auth/session for the same authenticated browser session.
      in: header
      name: X-CSRF-Token
      type: apiKey
    BrowserSession:
      description: HttpOnly session cookie issued by browser login; deployment may configure its name.
      in: cookie
      name: everyn_session
      type: apiKey