Skip to main content
GET
/
projects
/
{project_reference}
/
agents
List Agents
curl --request GET \
  --url https://api.veryfront.com/projects/{project_reference}/agents \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "provider": {
        "organization": "<string>",
        "url": "<string>"
      },
      "version": "<string>",
      "capabilities": {
        "streaming": true,
        "push_notifications": true,
        "extensions": [
          "<string>"
        ]
      },
      "default_input_modes": [
        "<string>"
      ],
      "default_output_modes": [
        "<string>"
      ],
      "tools": [
        "<string>"
      ],
      "skills": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "tags": [
            "<string>"
          ],
          "examples": [
            "<string>"
          ]
        }
      ],
      "x-veryfront-model": "<string>",
      "x-veryfront-url": "<string>",
      "suggestions": {
        "suggestions": [
          {
            "id": "<string>",
            "type": "prompt",
            "title": "<string>",
            "prompt": "<string>",
            "description": "<string>"
          }
        ],
        "welcome_message": "<string>"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
project_reference
string
required

Query Parameters

​
runtime_target_kind
enum<string> | null
Available options:
production,
environment,
preview_branch
​
target_environment_id
string<uuid> | null
​
target_branch_id
string<uuid> | null
​
source_target_kind
enum<string>
Available options:
project,
production,
environment,
preview_branch

Response

Discovered project agents

​
data
object[]
required