List agents

http
GET /projects/{project_reference}/agents

List agents. Requires project.agents.read.

Servers

json
[
  {
    "url": "https://api.veryfront.com"
  }
]

Authentication

json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyAuth": []
  }
]
json
{
  "bearerAuth": {
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "JWT or API Key",
    "description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
  },
  "apiKeyAuth": {
    "type": "apiKey",
    "in": "header",
    "name": "X-API-Key",
    "description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
  }
}

Parameters

NameLocationRequiredDescription
project_referencepathYesProject slug, UUID, or domain that identifies the project.
runtime_target_kindqueryNo
target_environment_idqueryNo
target_branch_idqueryNo
source_target_kindqueryNo

Parameter contracts

json
[
  {
    "schema": {
      "$ref": "#/components/schemas/ProjectReference"
    },
    "required": true,
    "description": "Project slug, UUID, or domain that identifies the project.",
    "name": "project_reference",
    "in": "path"
  },
  {
    "schema": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "main_branch",
        "environment",
        "preview_branch",
        null
      ]
    },
    "required": false,
    "name": "runtime_target_kind",
    "in": "query"
  },
  {
    "schema": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "required": false,
    "name": "target_environment_id",
    "in": "query"
  },
  {
    "schema": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "required": false,
    "name": "target_branch_id",
    "in": "query"
  },
  {
    "schema": {
      "type": "string",
      "enum": [
        "project",
        "main_branch",
        "environment",
        "preview_branch"
      ]
    },
    "required": false,
    "name": "source_target_kind",
    "in": "query"
  }
]

Responses

200

Discovered agents

json
{
  "description": "Discovered agents",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AgentCardList"
      }
    }
  }
}

400

Bad request

json
{
  "description": "Bad request",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

401

Unauthorized

json
{
  "description": "Unauthorized",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

403

Forbidden

json
{
  "description": "Forbidden",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

404

Not found

json
{
  "description": "Not found",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

500

Server error

json
{
  "description": "Server error",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

503

internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.

json
{
  "description": "internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

Referenced contracts

components/parameters/ProjectReference

json
{
  "schema": {
    "$ref": "#/components/schemas/ProjectReference"
  },
  "required": true,
  "description": "Project slug, UUID, or domain that identifies the project.",
  "name": "project_reference",
  "in": "path"
}

components/schemas/ProjectReference

json
{
  "type": "string"
}

components/schemas/AgentCardList

json
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "Public agent summary. Saved system instructions are in the agent source document (get_agent_source)."
          },
          "provider": {
            "type": "object",
            "properties": {
              "organization": {
                "type": "string"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "organization",
              "url"
            ]
          },
          "version": {
            "type": "string"
          },
          "capabilities": {
            "type": "object",
            "properties": {
              "streaming": {
                "type": "boolean"
              },
              "push_notifications": {
                "type": "boolean"
              },
              "extensions": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "required": [
              "streaming",
              "push_notifications",
              "extensions"
            ]
          },
          "default_input_modes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "default_output_modes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "tools": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Source-selected tools summarized by the card as exact tool IDs. An empty array does not establish that tools are disabled. Read saved configuration from the agent source document and source-selected tools and integration readiness from agent capabilities; neither verifies execution grants."
          },
          "skills": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "tags": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "examples": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "required": [
                "id",
                "name"
              ]
            }
          },
          "suggestions": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "minLength": 1
                },
                {
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "string",
                      "minLength": 1
                    },
                    "prompt": {
                      "type": "string",
                      "minLength": 1
                    }
                  },
                  "required": [
                    "title",
                    "prompt"
                  ],
                  "additionalProperties": false
                }
              ]
            }
          },
          "kind": {
            "type": "string",
            "enum": [
              "source_project_agent",
              "installed_project_agent"
            ]
          },
          "can_run": {
            "type": "boolean",
            "description": "Whether the card supports invocation. When false, inspect runtime_readiness.status and runtime_readiness.reason before starting a run. True does not prove live runtime readiness, model availability, or execution authorization. These are checked when a run starts."
          },
          "source_type": {
            "type": "string",
            "enum": [
              "project",
              "catalog_install"
            ]
          },
          "installed_access": {
            "type": "object",
            "properties": {
              "grant_id": {
                "type": "string",
                "format": "uuid"
              },
              "relation": {
                "type": "string",
                "enum": [
                  "owner",
                  "admin",
                  "editor",
                  "viewer"
                ]
              },
              "service_account_id": {
                "type": "string",
                "format": "uuid"
              },
              "project_id": {
                "type": "string",
                "format": "uuid"
              },
              "status": {
                "type": "string"
              }
            },
            "required": [
              "grant_id",
              "relation",
              "service_account_id",
              "project_id",
              "status"
            ]
          },
          "runtime_readiness": {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "ready",
                  "offline",
                  "not_applicable",
                  "unknown"
                ]
              },
              "reason": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "runtime_target_kind": {
                "type": [
                  "string",
                  "null"
                ],
                "enum": [
                  "registered_push_service",
                  "pull_worker",
                  null
                ]
              },
              "runtime_service_key": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "status",
              "reason",
              "runtime_target_kind",
              "runtime_service_key"
            ],
            "description": "Readiness of a registered push or pull runtime service, when one applies. For a source agent, not_applicable means this service check does not apply; it does not mean the agent cannot run. This field does not verify model availability or execution access."
          },
          "source_path": {
            "type": "string"
          },
          "edit_mode": {
            "type": "string",
            "enum": [
              "structured",
              "source_only"
            ]
          },
          "avatar_url": {
            "type": [
              "string",
              "null"
            ],
            "format": "uri",
            "description": "Absolute URL for this agent avatar. Null when no custom avatar has been set."
          },
          "model": {
            "type": [
              "string",
              "null"
            ],
            "description": "Model identifier exposed by the agent card. Null does not mean a model is required or identify the model a run will use. Model selection and availability are checked at run admission."
          },
          "url": {
            "type": "string",
            "description": "URL of the agent."
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "provider",
          "version",
          "capabilities",
          "default_input_modes",
          "default_output_modes",
          "tools",
          "skills",
          "kind",
          "can_run",
          "source_type",
          "source_path",
          "edit_mode",
          "model",
          "url"
        ]
      }
    },
    "diagnostics": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "source_file_diagnostic",
              "source_agent_discovery_error",
              "source_trigger_discovery_error"
            ]
          },
          "source_kind": {
            "type": "string",
            "enum": [
              "agent",
              "prompt",
              "tool",
              "task",
              "workflow",
              "resource",
              "skill",
              "eval",
              "schedule",
              "webhook"
            ]
          },
          "source_path": {
            "type": "string",
            "minLength": 1
          },
          "source_id": {
            "type": "string",
            "minLength": 1
          },
          "code": {
            "type": "string",
            "enum": [
              "parse_error",
              "invalid_definition",
              "dynamic_definition",
              "duplicate_source_id",
              "unsupported_target",
              "manual_conflict"
            ]
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "details": {
            "type": "object",
            "additionalProperties": {}
          }
        },
        "required": [
          "kind",
          "source_kind",
          "source_path",
          "code",
          "message"
        ]
      }
    }
  },
  "required": [
    "data"
  ]
}

components/schemas/Problem

json
{
  "type": "object",
  "properties": {
    "cause": {
      "type": "string",
      "enum": [
        "schedule_concurrency_forbidden",
        "schedule_fire_in_progress",
        "schedule_run_limit_reached"
      ],
      "description": "Schedule admission refusal."
    },
    "idempotency": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string",
          "enum": [
            "in_progress",
            "payload_mismatch",
            "outcome_unknown"
          ]
        },
        "operation": {
          "type": "string",
          "minLength": 1
        },
        "retryable": {
          "type": "boolean"
        },
        "retry_after_seconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "recovery": {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "description": {
              "type": "string"
            },
            "resource_url": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "description"
          ]
        }
      },
      "required": [
        "state",
        "operation",
        "retryable",
        "retry_after_seconds",
        "expires_at"
      ],
      "description": "Replay status, retry timing, and recovery lookup."
    },
    "type": {
      "type": "string",
      "description": "URI reference identifying the problem type",
      "example": "https://api.veryfront.com/errors/validation-failed"
    },
    "title": {
      "type": "string",
      "description": "Short human-readable summary of the problem",
      "example": "Validation Failed"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599,
      "description": "HTTP status code",
      "example": 400
    },
    "code": {
      "type": "string",
      "description": "Stable machine-readable error code",
      "example": "RUN_INVALID_INPUT"
    },
    "detail": {
      "type": "string",
      "description": "Human-readable explanation specific to this occurrence",
      "example": "The 'email' field must be a valid email address"
    },
    "instance": {
      "type": "string",
      "description": "URI reference identifying the specific occurrence",
      "example": "/projects/my-project/members"
    },
    "slug": {
      "type": "string",
      "description": "Stable identifier for the problem type",
      "example": "validation-failed"
    },
    "category": {
      "type": "string",
      "enum": [
        "AUTH",
        "RESOURCE",
        "VALIDATION",
        "DATABASE",
        "SUBSCRIPTION",
        "INTEGRATION",
        "INTERNAL"
      ],
      "description": "API error category",
      "example": "VALIDATION"
    },
    "suggestion": {
      "type": "string",
      "description": "Suggested action to resolve the problem",
      "example": "Check the request body and query parameters against the API documentation."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "Field path that caused the error",
            "example": "email"
          },
          "message": {
            "type": "string",
            "description": "Error message for this field",
            "example": "Invalid email format"
          },
          "code": {
            "type": "string",
            "description": "Error code for this field",
            "example": "INVALID_FORMAT"
          }
        },
        "required": [
          "field",
          "message"
        ]
      },
      "description": "Detailed field-level errors for validation failures"
    }
  },
  "required": [
    "type",
    "title",
    "status"
  ]
}

Operation contract

json
{
  "operationId": "listAgents",
  "tags": [
    "agents/Agents/Agents"
  ],
  "summary": "List agents",
  "description": "List agents. Requires project.agents.read.",
  "parameters": [
    {
      "$ref": "#/components/parameters/ProjectReference"
    },
    {
      "schema": {
        "type": [
          "string",
          "null"
        ],
        "enum": [
          "main_branch",
          "environment",
          "preview_branch",
          null
        ]
      },
      "required": false,
      "name": "runtime_target_kind",
      "in": "query"
    },
    {
      "schema": {
        "type": [
          "string",
          "null"
        ],
        "format": "uuid"
      },
      "required": false,
      "name": "target_environment_id",
      "in": "query"
    },
    {
      "schema": {
        "type": [
          "string",
          "null"
        ],
        "format": "uuid"
      },
      "required": false,
      "name": "target_branch_id",
      "in": "query"
    },
    {
      "schema": {
        "type": "string",
        "enum": [
          "project",
          "main_branch",
          "environment",
          "preview_branch"
        ]
      },
      "required": false,
      "name": "source_target_kind",
      "in": "query"
    }
  ],
  "responses": {
    "200": {
      "description": "Discovered agents",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AgentCardList"
          }
        }
      }
    },
    "400": {
      "description": "Bad request",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "404": {
      "description": "Not found",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "500": {
      "description": "Server error",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "503": {
      "description": "internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    }
  },
  "x-documentation-source-tag": "Project agents",
  "x-canonical-documentation": {
    "domain": "agents",
    "resource": "Agents",
    "subgroup": "Agents",
    "name": "List agents",
    "description": "List agents. Requires project.agents.read.",
    "operationId": "listAgents"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/agents-agents-agents/list-agents"
  }
}