openapi: 3.2.0
info:
  description: Relevance AI Endpoints
  title: Relevance AI Endpoints Replicate API
  version: latest
  contact:
    email: dev@tryrelevance.com
servers:
- url: /latest
security:
- AuthorizationHeader:
  - Authorization
tags:
- name: Replicate
paths:
  /replicate/collections:
    get:
      summary: GetReplicateCollections
      tags:
      - Replicate
      description: 'Get all available Replicate collections


        ### Required permissions

        > []'
      operationId: GetReplicateCollections
      parameters: []
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReplicateCollectionsOutput'
  /replicate/collections/{slug_name}/models:
    get:
      summary: GetReplicateCollectionModels
      tags:
      - Replicate
      description: 'Get models in a specific Replicate collection with pagination


        ### Required permissions

        > []'
      operationId: GetReplicateCollectionModels
      parameters:
      - name: slug_name
        in: path
        description: ID of slug_name
        required: true
        schema:
          type: string
          maxLength: 240
          pattern: ^[a-zd._-]+$
      - in: query
        name: page
        schema:
          type: number
          minimum: 1
          default: 1
        description: ''
      - in: query
        name: page_size
        schema:
          type: number
          minimum: 1
          maximum: 100
          default: 20
        description: ''
      - in: query
        name: search
        schema:
          type: string
          description: Search term to filter models by model_id, name, relevance_friendly_name, or description (case-insensitive)
        description: Search term to filter models by model_id, name, relevance_friendly_name, or description (case-insensitive)
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReplicateCollectionModelsOutput'
  /replicate/models/schema:
    get:
      summary: GetReplicateModelSchema
      tags:
      - Replicate
      description: 'Get input and output schema for a specific Replicate model


        ### Required permissions

        > []'
      operationId: GetReplicateModelSchema
      parameters:
      - in: query
        name: collection_slug
        schema:
          type: string
        description: ''
      - in: query
        name: model_id
        schema:
          type: string
        description: ''
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReplicateModelSchemaOutput'
components:
  schemas:
    GetReplicateCollectionsOutput:
      type: object
      properties:
        fetched_at:
          type: string
        collection_count:
          type: number
        collections:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              slug:
                type: string
              description:
                type: string
              model_count:
                type: number
              cover_image_url:
                type: string
              cover_video_url:
                type: string
              url:
                type: string
              featured_models:
                type: array
                items:
                  type: string
            required:
            - name
            - slug
            - description
            - model_count
            - url
            additionalProperties: true
      required:
      - fetched_at
      - collection_count
      - collections
      additionalProperties: false
    GetReplicateCollectionModelsOutput:
      type: object
      properties:
        collection_name:
          type: string
        collection_slug:
          type: string
        fetched_at:
          type: string
        total_count:
          type: number
        page:
          type: number
        page_size:
          type: number
        total_pages:
          type: number
        models:
          type: array
          items:
            type: object
            properties:
              model_id:
                type: string
              owner:
                type: string
              name:
                type: string
              description:
                type:
                - string
                - 'null'
              collection:
                type: string
              run_count:
                type: number
              cover_image_url:
                type:
                - string
                - 'null'
              cover_video_url:
                type:
                - string
                - 'null'
              input_schema:
                type: object
                additionalProperties: true
              output_schema:
                type: object
                additionalProperties: true
              output_type_hint:
                type: string
              relevance_friendly_name:
                type: string
              example_input:
                type: object
                additionalProperties: true
              example_output:
                type: object
                additionalProperties: true
              parameters_ui:
                type: object
                additionalProperties: true
              example:
                type:
                - object
                - 'null'
                properties:
                  input:
                    type: object
                    additionalProperties: true
                  output: {}
                  predict_time:
                    type: number
                additionalProperties: true
              example_inputs_media:
                type:
                - array
                - 'null'
                items:
                  type: string
              example_outputs_media:
                type:
                - array
                - 'null'
                items:
                  type: string
              version_id:
                type: string
              pricing:
                type: object
                additionalProperties: true
              metadata:
                type: object
                additionalProperties: true
              latest_version:
                type: object
                properties:
                  id:
                    type: string
                  openapi_schema:
                    type: object
                    properties:
                      components:
                        type: object
                        properties:
                          schemas:
                            type: object
                            properties:
                              Input:
                                type: object
                                additionalProperties: true
                              Output:
                                type: object
                                additionalProperties: true
                            additionalProperties: true
                        additionalProperties: true
                    additionalProperties: true
                additionalProperties: true
            required:
            - model_id
            - owner
            - name
            - description
            - collection
            additionalProperties: true
      required:
      - collection_name
      - collection_slug
      - fetched_at
      - total_count
      - page
      - page_size
      - total_pages
      - models
      additionalProperties: false
    GetReplicateModelSchemaOutput:
      type: object
      properties:
        input_schema: {}
        output_schema: {}
      required:
      - input_schema
      - output_schema
      additionalProperties: false
  securitySchemes:
    AuthorizationHeader:
      type: apiKey
      in: header
      name: Authorization
      description: 'Authorization credentials. Header authorization should be in the form of: project:api_key'