Freeplay

Freeplay Agents API

List agents within a project.

GitHub OpenAPI

Operations 5

POST /api/v2/projects/{project_id}/agents Create Agent #
GET /api/v2/projects/{project_id}/agents List Agents #
GET /api/v2/projects/{project_id}/agents/{agent_id} Get Agent #
PATCH /api/v2/projects/{project_id}/agents/{agent_id} Update Agent #
DELETE /api/v2/projects/{project_id}/agents/{agent_id} Delete Agent #

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://artifacts.apis.io/freeplay/openapi/freeplay-agents-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://artifacts.apis.io/freeplay/collections/freeplay.postman_collection.json
🔗
OpenCollection
https://artifacts.apis.io/freeplay/collections/freeplay.opencollection.json
🔗
APIsJSON
https://artifacts.apis.io/freeplay/apis.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/freeplay:freeplay-agents-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

freeplay-agents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Freeplay Agents API
  version: 0.1.0
security:
- BearerAuth: []
tags:
- name: Agents
paths:
  /api/v2/projects/{project_id}/agents:
    post:
      parameters:
      - name: project_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
                required:
                - id
                - name
                title: AgentInfo
                type: object
          description: 'AgentInfo(id: uuid.UUID, name: str)'
      description: Create a new agent in your project. Agents are used to organize and group related sessions and traces.
      summary: Create Agent
      tags:
      - Agents
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  title: Name
                  type: string
                id:
                  default: null
                  title: Id
                  format: uuid
                  type:
                  - string
                  - 'null'
              required:
              - name
              title: CreateAgentRequest
              type: object
      operationId: post_create_agent
    get:
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        schema:
          default: 1
          title: Page
          type: integer
      - name: page_size
        in: query
        schema:
          default: 30
          title: Page Size
          type: integer
      - name: name
        in: query
        schema:
          default: null
          title: Name
          type:
          - string
          - 'null'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/AgentInfo'
                    title: Data
                    type: array
                  pagination:
                    $ref: '#/components/schemas/PaginationInfo'
                required:
                - data
                - pagination
                title: GetAgentsResponsePayload
                type: object
          description: 'GetAgentsResponsePayload(data: list[server.api_routes.agents_api_v2.AgentInfo], pagination: server.api_routes.api_v2_common.PaginationInfo)'
      description: 'Retrieve a paginated list of agents for your project. Optionally filter by name.


        `page_size` defaults to 30, maximum 100.'
      summary: List Agents
      tags:
      - Agents
      operationId: get_get_agents
  /api/v2/projects/{project_id}/agents/{agent_id}:
    get:
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: agent_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
                required:
                - id
                - name
                title: AgentInfo
                type: object
          description: 'AgentInfo(id: uuid.UUID, name: str)'
      description: Retrieve details for a specific agent by ID.
      summary: Get Agent
      tags:
      - Agents
      operationId: get_get_agent
    patch:
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: agent_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
                required:
                - id
                - name
                title: AgentInfo
                type: object
          description: 'AgentInfo(id: uuid.UUID, name: str)'
      description: Update the name of an existing agent.
      summary: Update Agent
      tags:
      - Agents
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  title: Name
                  type: string
              required:
              - name
              title: UpdateAgentRequest
              type: object
      operationId: patch_update_agent
    delete:
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties: {}
                title: EmptyResponse
                type: object
          description: EmptyResponse()
      description: Delete an agent from your project. This operation cannot be undone.
      summary: Delete Agent
      tags:
      - Agents
      operationId: delete_delete_agent
components:
  schemas:
    AgentInfo:
      properties:
        id:
          format: uuid
          title: Id
          type: string
        name:
          title: Name
          type: string
      required:
      - id
      - name
      title: AgentInfo
      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)