Coactive

Coactive ingestion > ingest API

The ingestion > ingest API from Coactive — 6 operation(s) for ingestion > ingest.

GitHub OpenAPI
Business capability
Asset Ingest & Quality Control BC-3710.10

Operations 6

POST /api/v1/ingestion/metadata Add/Update Metadata #
POST /api/v1/ingestion/assets Create Ingest Job From Assets #
POST /api/v1/ingestion/buckets Create Ingest Job From Bucket #
POST /api/v1/ingestion/files Create Ingest Job From File #
POST /api/v1/ingestion/images Create Ingest Job From Images #
POST /api/v1/ingestion/videos Create Ingest Job From Videos #

Documentation

📖
Documentation
https://docs.coactive.ai/
📖
APIReference
https://docs.coactive.ai/api-reference/api-reference
📖
Authentication
https://artifacts.apis.io/coactive/authentication/coactive-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/coactive/openapi/coactive-ingestion-ingest-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/coactive/json-schema/coactive-ingestion-create-ingest-job-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/coactive/json-schema/coactive-ingestion-create-ingest-job-from-bucket-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/coactive/json-schema/coactive-ingestion-create-ingest-job-for-metadata-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/coactive/json-schema/coactive-ingestion-create-ingest-job-from-file-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/coactive/json-schema/coactive-ingestion-create-ingest-job-from-assets-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/coactive/json-schema/coactive-ingestion-create-ingest-job-from-images-request-schema.json

Other Resources

🔗
ErrorCatalog
https://artifacts.apis.io/coactive/errors/coactive-error-codes.yml
🔗
Conventions
https://artifacts.apis.io/coactive/conventions/coactive-conventions.yml
🔗
DataModel
https://artifacts.apis.io/coactive/data-model/coactive-data-model.yml

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/coactive:coactive-ingestion-ingest-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

coactive-ingestion-ingest-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Reference ingestion > ingest API
  version: 1.0.0
servers:
- url: https://api.coactive.ai
  description: Production
- url: https://app.coactive.ai
  description: Production
tags:
- name: ingestion > ingest
paths:
  /api/v1/ingestion/metadata:
    post:
      operationId: ingestion_ingest_create_ingest_job_for_metadata_api_v1_ingestion_metadata_post
      summary: Add/Update Metadata
      description: Update metadata for ingested assets
      tags:
      - ingestion > ingest
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ingestion_CreateIngestJobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ingestion_HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ingestion_CreateIngestJobForMetadataRequest'
      security:
      - HTTPBearer: []
  /api/v1/ingestion/assets:
    post:
      operationId: ingestion_ingest_create_ingest_job_from_assets_api_v1_ingestion_assets_post
      summary: Create Ingest Job From Assets
      description: Ingest assets directly, using a batch/list specification
      tags:
      - ingestion > ingest
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ingestion_CreateIngestJobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ingestion_HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ingestion_CreateIngestJobFromAssetsRequest'
      security:
      - HTTPBearer: []
  /api/v1/ingestion/buckets:
    post:
      operationId: ingestion_ingest_create_ingest_job_from_bucket_api_v1_ingestion_buckets_post
      summary: Create Ingest Job From Bucket
      description: Ingest assets from a bucket scan
      tags:
      - ingestion > ingest
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ingestion_CreateIngestJobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ingestion_HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ingestion_CreateIngestJobFromBucketRequest'
      security:
      - HTTPBearer: []
  /api/v1/ingestion/files:
    post:
      operationId: ingestion_ingest_create_ingest_job_from_file_api_v1_ingestion_files_post
      summary: Create Ingest Job From File
      description: Ingest assets from a CSV or JSON file
      tags:
      - ingestion > ingest
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ingestion_CreateIngestJobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ingestion_HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ingestion_CreateIngestJobFromFileRequest'
      security:
      - HTTPBearer: []
  /api/v1/ingestion/images:
    post:
      operationId: ingestion_ingest_create_ingest_job_from_images_api_v1_ingestion_images_post
      summary: Create Ingest Job From Images
      description: Ingest assets directly, using a batch/list specification
      tags:
      - ingestion > ingest
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ingestion_CreateIngestJobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ingestion_HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ingestion_CreateIngestJobFromImagesRequest'
      security:
      - HTTPBearer: []
  /api/v1/ingestion/videos:
    post:
      operationId: ingestion_ingest_create_ingest_job_from_videos_api_v1_ingestion_videos_post
      summary: Create Ingest Job From Videos
      description: Ingest assets directly, using a batch/list specification
      tags:
      - ingestion > ingest
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ingestion_CreateIngestJobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ingestion_HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ingestion_CreateIngestJobFromVideosRequest'
      security:
      - HTTPBearer: []
components:
  schemas:
    ingestion_AssetsJobDetails:
      type: object
      properties:
        assets:
          type: array
          items:
            $ref: '#/components/schemas/ingestion_AssetJobDetail'
      required:
      - assets
      title: AssetsJobDetails
    ingestion_IngestJobType:
      type: string
      enum:
      - unspecified
      - assets
      - file
      - bucket
      - metadata
      title: IngestJobType
    ingestion_IngestJobVideoMetadata:
      oneOf:
      - type: boolean
      - type: integer
      - type: number
        format: double
      - type: string
      - type: string
        format: date-time
      title: IngestJobVideoMetadata
    ingestion_CreateIngestJobFromFileRequest:
      type: object
      properties:
        dataset_id:
          type: string
          format: uuid
        source_path:
          type: string
        connection_name:
          type:
          - string
          - 'null'
        file_type:
          $ref: '#/components/schemas/ingestion_ExternalFileType'
      required:
      - dataset_id
      - source_path
      title: CreateIngestJobFromFileRequest
    ingestion_ExistingAssetMetadataUpdateMetadata:
      oneOf:
      - type: boolean
      - type: integer
      - type: number
        format: double
      - type: string
      - type: string
        format: date-time
      title: ExistingAssetMetadataUpdateMetadata
    ingestion_AssetJobDetail:
      type: object
      properties:
        asset:
          $ref: '#/components/schemas/ingestion_IngestJobAsset'
        asset_id:
          type:
          - string
          - 'null'
          format: uuid
        error:
          type:
          - string
          - 'null'
      required:
      - asset
      title: AssetJobDetail
    ingestion_ValidationError:
      type: object
      properties:
        loc:
          type: array
          items:
            $ref: '#/components/schemas/ingestion_ValidationErrorLocItems'
        msg:
          type: string
        type:
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ingestion_MetadataUpdateType:
      type: string
      enum:
      - overwrite
      - upsert
      - remove
      title: MetadataUpdateType
    ingestion_ExistingAssetMetadataUpdate:
      type: object
      properties:
        asset_id:
          type:
          - string
          - 'null'
          format: uuid
        source_path:
          type:
          - string
          - 'null'
        asset_type:
          $ref: '#/components/schemas/ingestion_ExplicitExternalAssetType'
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/ingestion_ExistingAssetMetadataUpdateMetadata'
      required:
      - asset_type
      title: ExistingAssetMetadataUpdate
    ingestion_ExternalCloudStorageProvider:
      type: string
      enum:
      - aws
      title: ExternalCloudStorageProvider
    ingestion_IngestJobImageMetadata:
      oneOf:
      - type: boolean
      - type: integer
      - type: number
        format: double
      - type: string
      - type: string
        format: date-time
      title: IngestJobImageMetadata
    ingestion_BucketJobDetails:
      type: object
      properties:
        path:
          type: string
        spec:
          $ref: '#/components/schemas/ingestion_BucketSpec'
        max_depth:
          type: integer
          default: 0
      required:
      - path
      - spec
      title: BucketJobDetails
    ingestion_CreateIngestJobFromAssetsRequest:
      type: object
      properties:
        dataset_id:
          type: string
          format: uuid
        connection_name:
          type:
          - string
          - 'null'
        assets:
          type: array
          items:
            $ref: '#/components/schemas/ingestion_IngestJobAsset'
      required:
      - dataset_id
      - assets
      title: CreateIngestJobFromAssetsRequest
    ingestion_IngestJobImage:
      type: object
      properties:
        source_path:
          type: string
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/ingestion_IngestJobImageMetadata'
      required:
      - source_path
      title: IngestJobImage
    ingestion_ExternalFileType:
      type: string
      enum:
      - unspecified
      - csv
      - json
      title: ExternalFileType
    ingestion_IngestJobAsset:
      type: object
      properties:
        source_path:
          type: string
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/ingestion_IngestJobAssetMetadata'
        asset_type:
          $ref: '#/components/schemas/ingestion_ExternalAssetType'
      required:
      - source_path
      title: IngestJobAsset
    ingestion_HTTPValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ingestion_ValidationError'
      title: HTTPValidationError
    ingestion_ExplicitExternalAssetType:
      type: string
      enum:
      - image
      - video
      title: ExplicitExternalAssetType
    ingestion_FileJobDetails:
      type: object
      properties:
        file:
          $ref: '#/components/schemas/ingestion_CreateIngestJobFromFileRequest'
      required:
      - file
      title: FileJobDetails
    ingestion_IngestJobVideo:
      type: object
      properties:
        source_path:
          type: string
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/ingestion_IngestJobVideoMetadata'
      required:
      - source_path
      title: IngestJobVideo
    ingestion_InternalAssetMetadataUpdateMetadata:
      oneOf:
      - type: boolean
      - type: integer
      - type: number
        format: double
      - type: string
      - type: string
        format: date-time
      title: InternalAssetMetadataUpdateMetadata
    ingestion_CreateIngestJobFromBucketRequest:
      type: object
      properties:
        dataset_id:
          type: string
          format: uuid
        connection_name:
          type:
          - string
          - 'null'
        path:
          type:
          - string
          - 'null'
        spec:
          oneOf:
          - $ref: '#/components/schemas/ingestion_BucketSpec'
          - type: 'null'
        source_path:
          type:
          - string
          - 'null'
        source_spec:
          oneOf:
          - $ref: '#/components/schemas/ingestion_BucketSpec'
          - type: 'null'
        max_depth:
          type: integer
          minimum: 0
          maximum: 10
          default: 0
          description: Max depth of recursion under a prefix
      required:
      - dataset_id
      title: CreateIngestJobFromBucketRequest
    ingestion_CreateIngestJobFromVideosRequest:
      type: object
      properties:
        dataset_id:
          type: string
          format: uuid
        connection_name:
          type:
          - string
          - 'null'
        videos:
          type: array
          items:
            $ref: '#/components/schemas/ingestion_IngestJobVideo'
      required:
      - dataset_id
      - videos
      title: CreateIngestJobFromVideosRequest
    ingestion_ValidationErrorLocItems:
      oneOf:
      - type: string
      - type: integer
      title: ValidationErrorLocItems
    ingestion_RequestType:
      type: string
      enum:
      - submit
      title: RequestType
    ingestion_CreateIngestJobFromImagesRequest:
      type: object
      properties:
        dataset_id:
          type: string
          format: uuid
        connection_name:
          type:
          - string
          - 'null'
        images:
          type: array
          items:
            $ref: '#/components/schemas/ingestion_IngestJobImage'
      required:
      - dataset_id
      - images
      title: CreateIngestJobFromImagesRequest
    ingestion_CreateIngestJobForMetadataRequest:
      type: object
      properties:
        dataset_id:
          type: string
          format: uuid
        update_assets:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ingestion_ExistingAssetMetadataUpdate'
        source_path:
          type:
          - string
          - 'null'
        update_type:
          $ref: '#/components/schemas/ingestion_MetadataUpdateType'
      required:
      - dataset_id
      title: CreateIngestJobForMetadataRequest
    ingestion_ExternalAssetType:
      type: string
      enum:
      - unspecified
      - image
      - video
      title: ExternalAssetType
    ingestion_IngestJobStatusEnum:
      type: string
      enum:
      - completed
      - failed
      - in_progress
      - pending
      - paused
      - stopping
      - stopped
      description: Enum of Ingest Job Status.
      title: IngestJobStatusEnum
    ingestion_InternalAssetMetadataUpdate:
      type: object
      properties:
        asset_id:
          type: string
          format: uuid
        source_path:
          type:
          - string
          - 'null'
        asset_type:
          $ref: '#/components/schemas/ingestion_ExplicitExternalAssetType'
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/ingestion_InternalAssetMetadataUpdateMetadata'
      required:
      - asset_id
      - source_path
      - asset_type
      title: InternalAssetMetadataUpdate
    ingestion_BucketSpec:
      type: object
      properties:
        bucket:
          type: string
        prefix:
          type: string
          default: /
        provider:
          $ref: '#/components/schemas/ingestion_ExternalCloudStorageProvider'
      required:
      - bucket
      title: BucketSpec
    ingestion_IngestJobAssetMetadata:
      oneOf:
      - type: boolean
      - type: integer
      - type: number
        format: double
      - type: string
      - type: string
        format: date-time
      title: IngestJobAssetMetadata
    ingestion_CreateIngestJobResponse:
      type: object
      properties:
        id:
          type: string
        org_id:
          type: string
        dataset_id:
          type: string
          format: uuid
        connection_name:
          type:
          - string
          - 'null'
        job_type:
          $ref: '#/components/schemas/ingestion_IngestJobType'
        details:
          oneOf:
          - $ref: '#/components/schemas/ingestion_CreateIngestJobResponseDetails'
          - type: 'null'
        request_type:
          $ref: '#/components/schemas/ingestion_RequestType'
        status:
          $ref: '#/components/schemas/ingestion_IngestJobStatusEnum'
        created_dt:
          type: string
          format: date-time
        updated_dt:
          type:
          - string
          - 'null'
          format: date-time
        total_assets:
          type:
          - integer
          - 'null'
        processed_assets:
          type: integer
          default: 0
        errored_assets:
          type: integer
          default: 0
        request_id:
          type:
          - string
          - 'null'
      required:
      - id
      - org_id
      - dataset_id
      - job_type
      - details
      - created_dt
      title: CreateIngestJobResponse
    ingestion_MetadataUpdateJobDetails:
      type: object
      properties:
        accepted:
          type: array
          items:
            $ref: '#/components/schemas/ingestion_InternalAssetMetadataUpdate'
        invalid_assets:
          type: array
          items:
            $ref: '#/components/schemas/ingestion_ExistingAssetMetadataUpdate'
      required:
      - accepted
      - invalid_assets
      title: MetadataUpdateJobDetails
    ingestion_CreateIngestJobResponseDetails:
      oneOf:
      - $ref: '#/components/schemas/ingestion_AssetsJobDetails'
      - $ref: '#/components/schemas/ingestion_FileJobDetails'
      - $ref: '#/components/schemas/ingestion_BucketJobDetails'
      - $ref: '#/components/schemas/ingestion_MetadataUpdateJobDetails'
      title: CreateIngestJobResponseDetails
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Coactive
  source: https://docs.coactive.ai/openapi.json
  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)