Artie Ingestion API Keys API

openapi: 3.2.0
info:
  description: External API endpoints for Artie
  title: Artie Ingestion API Keys API
  version: v1.0.139
servers:
- url: https://api.artie.com
security:
- ApiKey: []
tags:
- name: Ingestion API Keys
paths:
  /ingestion-api-keys:
    post:
      description: Creates a new ingestion API key for a source reader. Returns the key and its secret (only shown once).
      operationId: ingestion_api_key_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouterCreateIngestionAPIKeyRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouterCreateIngestionAPIKeyResponse'
          description: OK
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
      summary: Create an ingestion API key
      tags:
      - Ingestion API Keys
      x-artie-mcp:
        destructiveHint: false
        exclusionReason: Returns an ingestion API key secret that is shown only once.
        exposure: excluded
        idempotentHint: false
        inputSensitivity: none
        openWorldHint: false
        operationId: ingestion_api_key_create
        outputSensitivity: restricted-credentials
        readOnlyHint: false
        remediation: Create ingestion API keys through the authenticated Dashboard setup flow.
        requiredScopes:
        - ingestion_api_keys:write
        retrySemantics: unsafe
        title: Create an ingestion API key
        triggerDescription: Use when you need to create an ingestion API key.
  /ingestion-api-keys/{uuid}:
    delete:
      description: Deletes an ingestion API key by UUID.
      operationId: ingestion_api_key_delete
      parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '500':
          description: Internal Server Error
      summary: Delete an ingestion API key
      tags:
      - Ingestion API Keys
      x-artie-mcp:
        bodilessSuccess: true
        destructiveHint: true
        exposure: exposed
        idempotentHint: false
        inputSensitivity: none
        openWorldHint: false
        operationId: ingestion_api_key_delete
        outputSensitivity: none
        readOnlyHint: false
        requiredScopes:
        - ingestion_api_keys:delete
        retrySemantics: safe-after-state-check
        title: Delete an ingestion API key
        triggerDescription: Deletes an ingestion API key by UUID.
    post:
      description: Updates an existing ingestion API key by UUID.
      operationId: ingestion_api_key_update
      parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouterUpdateIngestionAPIKeyRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadsIngestionAPIKey'
          description: OK
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
      summary: Update an ingestion API key
      tags:
      - Ingestion API Keys
      x-artie-mcp:
        destructiveHint: false
        exposure: exposed
        idempotentHint: false
        inputSensitivity: none
        openWorldHint: false
        operationId: ingestion_api_key_update
        outputSensitivity: none
        readOnlyHint: false
        requiredScopes:
        - ingestion_api_keys:write
        retrySemantics: unsafe
        title: Update an ingestion API key
        triggerDescription: Updates metadata on an existing ingestion API key. Does not mint a new key.
components:
  schemas:
    RouterCreateIngestionAPIKeyResponse:
      properties:
        ingestionAPIKey:
          $ref: '#/components/schemas/PayloadsIngestionAPIKey'
        secret:
          type: string
      required:
      - ingestionAPIKey
      - secret
      type: object
    PayloadsIngestionAPIKey:
      properties:
        companyUUID:
          format: uuid
          type: string
        createdAt:
          format: date-time
          type: string
        expiresAt:
          format: date-time
          type:
          - 'null'
          - string
        last4:
          type: string
        name:
          type: string
        sourceReaderUUID:
          format: uuid
          type: string
        updatedAt:
          format: date-time
          type: string
        uuid:
          format: uuid
          type: string
      required:
      - uuid
      - createdAt
      - updatedAt
      - name
      - last4
      - sourceReaderUUID
      - companyUUID
      type: object
    RouterCreateIngestionAPIKeyRequest:
      properties:
        name:
          type: string
        sourceReaderUUID:
          format: uuid
          type: string
      required:
      - sourceReaderUUID
      type: object
    RouterUpdateIngestionAPIKeyRequest:
      properties:
        expiresAt:
          format: date-time
          type:
          - 'null'
          - string
        name:
          type: string
      type: object
  securitySchemes:
    ApiKey:
      description: API key passed as a Bearer token in the Authorization header.
      scheme: bearer
      type: http
x-provenance:
  method: harvested
  publisher: Artie
  source: https://raw.githubusercontent.com/artie-labs/artie-api-spec/refs/heads/master/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)