Freeplay

Freeplay Models API

The Models API from Freeplay — 2 operation(s) for models.

GitHub OpenAPI

Operations 5

GET /api/v2/models List Models #
POST /api/v2/models Create Model #
GET /api/v2/models/{model_id} Get Model #
PUT /api/v2/models/{model_id} Update Model #
DELETE /api/v2/models/{model_id} Delete Model #

Documentation

📖
Documentation
https://docs.freeplay.ai/docs/freeplay-sdk
📖
APIReference
https://docs.freeplay.ai/developer-resources/api-reference
📖
Documentation
https://docs.freeplay.ai/getting-started/integrate
📖
Documentation
https://docs.freeplay.ai/docs/quick-start
📖
Documentation
https://freeplay.ai/blog/llm-evaluation

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/freeplay/refs/heads/main/openapi/freeplay-models-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/freeplay/refs/heads/main/collections/freeplay.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/freeplay/refs/heads/main/collections/freeplay.opencollection.json

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/freeplay:freeplay-models-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

freeplay-models-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Freeplay Models API
  version: 0.1.0
security:
- BearerAuth: []
tags:
- name: Models
paths:
  /api/v2/models:
    get:
      parameters:
      - name: page
        in: query
        schema:
          default: 1
          title: Page
          type: integer
      - name: page_size
        in: query
        schema:
          default: 30
          title: Page Size
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/ModelReplicationInfo'
                    title: Data
                    type: array
                  pagination:
                    $ref: '#/components/schemas/PaginationInfo'
                required:
                - data
                - pagination
                title: ModelListResponse
                type: object
          description: 'ModelListResponse(data: list[server.api_routes.models_api_v2.ModelReplicationInfo], pagination: server.api_routes.api_v2_common.PaginationInfo)'
      description: 'Retrieve a paginated list of custom models configured for the account.


        `page_size` defaults to 30, maximum 100.'
      summary: List Models
      tags:
      - Models
      operationId: get_list_models
    post:
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  id:
                    format: uuid
                    title: Id
                    type: string
                  name:
                    title: Name
                    type: string
                  display_name:
                    title: Display Name
                    type:
                    - string
                    - 'null'
                  provider_name:
                    title: Provider Name
                    type: string
                  provider_info:
                    title: Provider Info
                    additionalProperties:
                      type: string
                    type:
                    - object
                    - 'null'
                  supports_tool_use:
                    title: Supports Tool Use
                    type: boolean
                  model_family:
                    title: Model Family
                    type: string
                  model_version:
                    title: Model Version
                    type: string
                  created_at:
                    format: date-time
                    title: Created At
                    type: string
                required:
                - id
                - name
                - display_name
                - provider_name
                - provider_info
                - supports_tool_use
                - model_family
                - model_version
                - created_at
                title: ModelReplicationInfo
                type: object
          description: 'ModelReplicationInfo(id: uuid.UUID, name: str, display_name: Optional[str], provider_name: str, provider_info: Optional[dict[str, str]], supports_tool_use: bool, model_family: str, model_version: str, created_at: datetime.datetime)'
      description: Create or upsert a custom model configuration for the account.
      summary: Create Model
      tags:
      - Models
      requestBody:
        content:
          application/json:
            schema:
              properties:
                id:
                  format: uuid
                  title: Id
                  type: string
                name:
                  title: Name
                  type: string
                provider_name:
                  title: Provider Name
                  type: string
                model_family:
                  title: Model Family
                  type: string
                model_version:
                  title: Model Version
                  type: string
                display_name:
                  default: null
                  title: Display Name
                  type:
                  - string
                  - 'null'
                provider_info:
                  default: null
                  title: Provider Info
                  additionalProperties:
                    type: string
                  type:
                  - object
                  - 'null'
                supports_tool_use:
                  default: true
                  title: Supports Tool Use
                  type: boolean
              required:
              - id
              - name
              - provider_name
              - model_family
              - model_version
              title: ReplicateModelRequest
              type: object
      operationId: post_replicate_model
  /api/v2/models/{model_id}:
    get:
      parameters:
      - name: model_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  id:
                    format: uuid
                    title: Id
                    type: string
                  name:
                    title: Name
                    type: string
                  display_name:
                    title: Display Name
                    type:
                    - string
                    - 'null'
                  provider_name:
                    title: Provider Name
                    type: string
                  provider_info:
                    title: Provider Info
                    additionalProperties:
                      type: string
                    type:
                    - object
                    - 'null'
                  supports_tool_use:
                    title: Supports Tool Use
                    type: boolean
                  model_family:
                    title: Model Family
                    type: string
                  model_version:
                    title: Model Version
                    type: string
                  created_at:
                    format: date-time
                    title: Created At
                    type: string
                required:
                - id
                - name
                - display_name
                - provider_name
                - provider_info
                - supports_tool_use
                - model_family
                - model_version
                - created_at
                title: ModelReplicationInfo
                type: object
          description: 'ModelReplicationInfo(id: uuid.UUID, name: str, display_name: Optional[str], provider_name: str, provider_info: Optional[dict[str, str]], supports_tool_use: bool, model_family: str, model_version: str, created_at: datetime.datetime)'
      description: Retrieve details for a specific custom model by ID.
      summary: Get Model
      tags:
      - Models
      operationId: get_get_model
    put:
      parameters:
      - name: model_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  id:
                    format: uuid
                    title: Id
                    type: string
                  name:
                    title: Name
                    type: string
                  display_name:
                    title: Display Name
                    type:
                    - string
                    - 'null'
                  provider_name:
                    title: Provider Name
                    type: string
                  provider_info:
                    title: Provider Info
                    additionalProperties:
                      type: string
                    type:
                    - object
                    - 'null'
                  supports_tool_use:
                    title: Supports Tool Use
                    type: boolean
                  model_family:
                    title: Model Family
                    type: string
                  model_version:
                    title: Model Version
                    type: string
                  created_at:
                    format: date-time
                    title: Created At
                    type: string
                required:
                - id
                - name
                - display_name
                - provider_name
                - provider_info
                - supports_tool_use
                - model_family
                - model_version
                - created_at
                title: ModelReplicationInfo
                type: object
          description: 'ModelReplicationInfo(id: uuid.UUID, name: str, display_name: Optional[str], provider_name: str, provider_info: Optional[dict[str, str]], supports_tool_use: bool, model_family: str, model_version: str, created_at: datetime.datetime)'
      description: Update an existing custom model configuration.
      summary: Update Model
      tags:
      - Models
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  title: Name
                  type: string
                provider_name:
                  title: Provider Name
                  type: string
                model_family:
                  title: Model Family
                  type: string
                model_version:
                  title: Model Version
                  type: string
                display_name:
                  default: null
                  title: Display Name
                  type:
                  - string
                  - 'null'
                provider_info:
                  default: null
                  title: Provider Info
                  additionalProperties:
                    type: string
                  type:
                  - object
                  - 'null'
                supports_tool_use:
                  default: true
                  title: Supports Tool Use
                  type: boolean
              required:
              - name
              - provider_name
              - model_family
              - model_version
              title: UpdateModelRequest
              type: object
      operationId: put_update_model
    delete:
      parameters:
      - name: model_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties: {}
                title: EmptyResponse
                type: object
          description: EmptyResponse()
      description: Delete a custom model configuration from the account.
      summary: Delete Model
      tags:
      - Models
      operationId: delete_delete_model
components:
  schemas:
    ModelReplicationInfo:
      properties:
        id:
          format: uuid
          title: Id
          type: string
        name:
          title: Name
          type: string
        display_name:
          title: Display Name
          type:
          - string
          - 'null'
        provider_name:
          title: Provider Name
          type: string
        provider_info:
          title: Provider Info
          additionalProperties:
            type: string
          type:
          - object
          - 'null'
        supports_tool_use:
          title: Supports Tool Use
          type: boolean
        model_family:
          title: Model Family
          type: string
        model_version:
          title: Model Version
          type: string
        created_at:
          format: date-time
          title: Created At
          type: string
      required:
      - id
      - name
      - display_name
      - provider_name
      - provider_info
      - supports_tool_use
      - model_family
      - model_version
      - created_at
      title: ModelReplicationInfo
      type: object
    PaginationInfo:
      properties:
        page:
          title: Page
          type: integer
        page_size:
          title: Page Size
          type: integer
        has_next:
          title: Has Next
          type: boolean
      required:
      - page
      - page_size
      - has_next
      title: PaginationInfo
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Freeplay
  source: https://app.freeplay.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)