openapi: 3.2.0
info:
  description: Relevance AI Endpoints
  title: Relevance AI Endpoints Fal AI API
  version: latest
  contact:
    email: dev@tryrelevance.com
servers:
- url: /latest
security:
- AuthorizationHeader:
  - Authorization
tags:
- name: fal_ai
paths:
  /fal_ai/categories:
    get:
      summary: GetFalAiCategories
      tags:
      - fal_ai
      description: 'Get all available fal.ai model categories


        ### Required permissions

        > []'
      operationId: GetFalAiCategories
      parameters: []
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFalAiCategoriesOutput'
  /fal_ai/models:
    get:
      summary: GetFalAiModels
      tags:
      - fal_ai
      description: 'Get all available fal.ai models with pagination and search


        ### Required permissions

        > []'
      operationId: GetFalAiModels
      parameters:
      - in: query
        name: search
        schema:
          type: string
          description: Search term to filter models by name or description
        description: Search term to filter models by name or description
      - in: query
        name: category
        schema:
          type: string
          description: Category filter (e.g. text-to-image, image-to-video)
        description: Category filter (e.g. text-to-image, image-to-video)
      - in: query
        name: limit
        schema:
          type: number
          minimum: 1
          maximum: 100
          default: 20
        description: ''
      - in: query
        name: cursor
        schema:
          type: string
          description: Pagination cursor from previous response
        description: Pagination cursor from previous response
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFalAiModelsOutput'
  /fal_ai/models/schema:
    get:
      summary: GetFalAiModelSchema
      tags:
      - fal_ai
      description: 'Get input schema for a specific fal.ai model


        ### Required permissions

        > []'
      operationId: GetFalAiModelSchema
      parameters:
      - in: query
        name: endpoint_id
        schema:
          type: string
          pattern: ^[a-zA-Z0-9._-]+(/[a-zA-Z0-9._-]+)*$
          maxLength: 256
        description: ''
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFalAiModelSchemaOutput'
components:
  schemas:
    GetFalAiModelSchemaOutput:
      type: object
      properties:
        input_schema:
          type: object
      required:
      - input_schema
      additionalProperties: false
    GetFalAiModelsOutput:
      type: object
      properties:
        models:
          type: array
          items:
            type: object
            properties:
              endpoint_id:
                type: string
              name:
                type: string
              description:
                type: string
              category:
                type: string
              thumbnail_url:
                type: string
            required:
            - endpoint_id
            - name
            - description
            - category
            additionalProperties: false
        next_cursor:
          type:
          - string
          - 'null'
      required:
      - models
      additionalProperties: false
    GetFalAiCategoriesOutput:
      type: object
      properties:
        categories:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              model_count:
                type: number
              thumbnail_url:
                type: string
            required:
            - name
            - model_count
            additionalProperties: false
      required:
      - categories
      additionalProperties: false
  securitySchemes:
    AuthorizationHeader:
      type: apiKey
      in: header
      name: Authorization
      description: 'Authorization credentials. Header authorization should be in the form of: project:api_key'